25.02 guide update for checking (html+images)

[offset-torque]

This change is 

[offset-torque]

@Frenzie - Can you have a look and merge this? Or should I?

[Frenzie]

Do you mean to overwrite the existing file with that which is in additions?

[offset-torque]

Both commits contain only new files, there shouldn't be any overwriting. This is the temporary proofreading file that devs will check.

"Have a look" confused you probably. I meant "have a look at my PR procedure if I am doing it right" because I did this long time ago. (You will also have a look at the file itself after it is uploaded since you are one of the proofreaders.)

[poire-z]

A bit tedious to get to what we should review (have to download the annotation.html and open it in a browser) - and you should ping the people summoned if you want them to notice they have something to read & give feedback :)

We can add more like these short and useful ones if you have more in mind poire-z

Nope, all the ones I had in mind ended up in our "shipped" style tweaks menu.

There are two types of style tweaks in KOReader:

There is a third (first) type: our shipped style tweaks, available via our Style tweaks> menu and organized there. You should mention that :)
And to get back to previous point (samples):
in this menu, long-press on a style tweak menu item to see its code and a comment describing what/how it does.
(unless all this is already mentionned in the user guide, so all this will read well depending on where you put the new stuff among the old stuff).

For the section about adding style tweaks to gesture or profiles, best to have @hius07 check it.

About Reference page number and your Is this enabled by default? if that is a question: no, it is not enabled by default, it might be bothering if it were to have page numbers vary depending on the publisher work (only show them in page margin is enabled by default, so a user can know they are available - and go at disabling them because it's also bothering, but less bothering :))

No further comment (about my section, and a really quick glance at the others).

[offset-torque]

Guys you don't understand what I am doing. So I am going step by step:

• Previously I was posting a PDF for review to the user guide thread
• Now I am uploading a HTML file
• After uploading this I will ping everyone
• But to ping everyone first I need this file online obviously
• Then devs will click the link and open this in their browser

Any questions?

[offset-torque]

To further clarify:

This is not the "Proofread this please" thread
This is "I am trying to upload this file so devs can see it when I link it from the user guide thread" thread

[Frenzie]

From this repo's perspective that would be a bit noisy, but if you prefer to do it that way that's fine.

[poire-z]

Dunno if we can "display" the HTML on this working branch before it is merged.
But it feels a bit awkward that you would use this repo's master branch to commit a "temporary file for reviewing" just so we can access and read the HTML, and have a second commit removing it and integrating it into the main html document.

[offset-torque]

From this repo's perspective that would be a bit noisy

I don't understand. I am adding a single html file (additions.html) which I will delete after the review process. Newly added images in this PR are part of the updated user guide already. So there will be no extra files in this repo after the update.

But it feels a bit awkward that you would use this repo's master branch to commit a "temporary file for reviewing" just so we can access and read the HTML, and have a second commit removing it and integrating it into the main html document.

I thought exactly this but the opposite. I need to host this file somewhere temporarily. Wouldn't it be more awkward if I upload it to some random free hosting site with ads peppered on it? Should I buy my own domain koreaderguideproofread.xyz for this task?

If I am doing wrong, what is the correct way of doing this?

[Frenzie]

Dunno if we can "display" the HTML on this working branch before it is merged.

The short answer's yes. The longer answer's that the v2 action is broken but I think v4 should work.

koreader.github.io/.github/workflows/manual-preview.yml

Lines 9 to 18 in b56d60d

	- name: Manual HTML Preview English
	id: html_preview_en
	uses: pavi2410/html-preview-action@v2
	with:
	html_file: 'user_guide/en.html'
	- name: Manual HTML Preview Persian (RTL)
	id: html_preview_fa
	uses: pavi2410/html-preview-action@v2
	with:
	html_file: 'user_guide/fa.html'

However, ignore that for now…

I thought exactly this but the opposite. I need to host this file somewhere temporarily. Wouldn't it be more awkward if I upload it to some random free hosting site with ads peppered on it? Should I buy my own domain koreaderguideproofread.xyz for this task?

You get a free one at offset-torque.github.io

See https://pages.github.com/ for more information.

In short, if you create a repository called offset-torque.github.io and you put an index.html in it, it'll show up at offset-torque.github.io.

I don't understand. I am adding a single html file (additions.html) which I will delete after the review process.

That's the noise. :-) (Plus a few bytes wasted storing the history.) It doesn't matter too much in this particular repo since it's not about code and just about being able to quickly revert a change if necessary, but temporary commits are normally something that is done prior to a final commit that ends up on the main/master branch.

[offset-torque]

Ok I will try this, thanks Frenzie:

In short, if you create a repository called offset-torque.github.io and you put an index.html in it, it'll show up at offset-torque.github.io.

[offset-torque]

Ok that was easier than I expected. I didn't know github pages was available to me too.
Does this look ok from your side: https://offset-torque.github.io/

And I don't know what to do with this PR Frenzie. I guess you are able to delete it.

[Frenzie]

Does this look ok from your side: https://offset-torque.github.io/

Definitely!

I'll just close it then.

Btw, if you check over on https://hosted.weblate.org/widgets/koreader/?component=27339 there are also some widgets that are updated live.

[offset-torque]

Those widgets are cool, I am adding one :)
I will make some small changes, reupload the file and then make the announcement.

Sorry for the confusion guys. I am still newbie at these parts of github.