Skip to content

docs: USER_GUIDE.md update for 1.1.0#1108

Merged
znelson merged 16 commits intocrosspoint-reader:masterfrom
divinitycove:master
Feb 23, 2026
Merged

docs: USER_GUIDE.md update for 1.1.0#1108
znelson merged 16 commits intocrosspoint-reader:masterfrom
divinitycove:master

Conversation

@divinitycove
Copy link
Contributor

@divinitycove divinitycove commented Feb 23, 2026

Summary

  • What is the goal of this PR? (e.g., Implements the new feature for file uploading.)

    • This PR updates the USER_GUIDE.md to match recent changes, in particular 1.1.0, alongside some minor copyediting.
  • What changes are included?

Additional Context

  • Add any other information that might be helpful for the reviewer (e.g., performance implications, potential risks,
    specific areas to focus on).

This is an admittedly quick edit I did to get USER_GUIDE.md up to scratch alongside the release of 1.1.0. I'm a writer, not a programmer, so there are some things that will probably need improvement.

  • Recent Books needs to be added, something I could add to this PR if needed.
  • Remap Front Buttons might need to be updated.

These have been added in later commits, Remap Front Buttons might still need more detail.

  • The UI Theme, Embedded Style, Hyphenation, WiFi Networks, KOReader Sync, and Clear Reading Cache settings might need better (or more technically specific) descriptions.

Two questions I have:

  • Should the new Settings subheadings be added to the Table of Contents? Added in later commits.
  • The Manual of Style/formatting for USER_GUIDE.md, especially in the Settings section, is somewhat inconsistent. Let me know if any of my edits don't fit with this.

AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? < YES | PARTIALLY | NO >
NO

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 23, 2026

📝 Walkthrough

Walkthrough

Reorganized the Screens section in USER_GUIDE.md: renamed Book Selection→Browse Files Screen and File Upload Screen→File Transfer Screen; split Settings into Display, Reader, Controls, and System subsections; updated navigation references, button/controls terminology, and related guidance across the document.

Changes

Cohort / File(s) Summary
Primary Doc
USER_GUIDE.md
Structural reorganization of Screens section: renamed screens (Book Selection → Browse Files Screen, File Upload Screen → File Transfer Screen); moved and retitled multiple subsections; updated Home Screen guidance and navigation paths.
Settings Expansion
USER_GUIDE.md
Split former Settings into detailed subsections: Display (modes, sleep/cover options, battery/UI theme), Reader (fonts, spacing, margins, hyphenation, embedded styles), Controls (button remapping, side/front layout, long-press actions), and System (sleep time, Wi‑Fi, KOReader Sync, OPDS, cache, updates, language).
Navigation & Terminology
USER_GUIDE.md
Replaced references to Book Selection/File Upload with Browse Files/Recent Books/File Transfer and Controls Settings; updated Return to Book Selection → Return to Home/Return to Browse Files and adjusted Chapter Menu/navigation wording.
Editorial
USER_GUIDE.md
Minor grammar and style edits throughout; rewrote reboot/power instructions to reference Controls Settings and firmware/frozen-state reboot guidance.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: a documentation update to USER_GUIDE.md for version 1.1.0, matching the changeset's primary focus.
Description check ✅ Passed The pull request description is clearly related to the changeset, describing specific updates to USER_GUIDE.md for version 1.1.0 including screen title renames, Settings section reorganization, and system navigation updates.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@divinitycove divinitycove changed the title USER_GUIDE.md update for 1.1.0 docs: USER_GUIDE.md update for 1.1.0 Feb 23, 2026
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Nitpick comments (1)
USER_GUIDE.md (1)

17-17: Consider adding Settings subsections to the Table of Contents.

The new Settings subsections (3.5.1 Display, 3.5.2 Reader, 3.5.3 Controls, 3.5.4 System) are not reflected in the TOC. Adding them would improve navigation, especially given the substantial expansion of the Settings section.

📑 Proposed TOC entries
     - [3.4 File Transfer Screen](`#34-file-transfer-screen`)
     - [3.4.1 Calibre Wireless Transfers](`#341-calibre-wireless-transfers`)
     - [3.5 Settings](`#35-settings`)
+      - [3.5.1 Display](`#351-display`)
+      - [3.5.2 Reader](`#352-reader`)
+      - [3.5.3 Controls](`#353-controls`)
+      - [3.5.4 System](`#354-system`)
     - [3.6 Sleep Screen](`#36-sleep-screen`)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@USER_GUIDE.md` at line 17, Update the Table of Contents entry for "3.5
Settings" to include the new subsections so links appear for 3.5.1–3.5.4;
specifically, beneath the existing "- [3.5 Settings](`#35-settings`)" TOC line add
entries for "- [3.5.1 Display](`#351-display`)", "- [3.5.2 Reader](`#352-reader`)",
"- [3.5.3 Controls](`#353-controls`)", and "- [3.5.4 System](`#354-system`)"
(matching the section headings' anchor formats) so readers can navigate directly
to each Settings subsection.
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 63002d4 and 4e037ab.

📒 Files selected for processing (1)
  • USER_GUIDE.md
🧰 Additional context used
🪛 LanguageTool
USER_GUIDE.md

[grammar] ~153-~153: Use a hyphen to join words.
Context: ...reader mode between 5 and 40 pixels in 5 pixel increments. - **Reader Paragraph A...

(QB_NEW_EN_HYPHEN)


[style] ~154-~154: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...nd 40 pixels in 5 pixel increments. - Reader Paragraph Alignment: Set the alignmen...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: cppcheck
🔇 Additional comments (5)
USER_GUIDE.md (5)

13-13: LGTM! Screen renaming is consistent throughout.

The renaming from "Book Selection" to "Browse Files Screen" and "File Upload Screen" to "File Transfer Screen" is consistently applied across section headers, TOC entries, and cross-references. The addition of "Return to Browse Files" navigation (line 233) properly addresses issue #726.

Also applies to: 15-15, 70-70, 72-74, 83-85, 232-233


108-144: LGTM! Display settings are well-documented.

The Display subsection provides comprehensive documentation for all display-related settings with clear option lists and descriptions.


165-181: LGTM! Controls settings are clearly documented.

The Controls subsection provides clear documentation for button configuration settings with well-organized option lists.


186-192: LGTM! System settings documentation is clear.

The remaining System settings are well-documented with appropriate detail for each configuration option.


55-55: LGTM! Clearer reboot instructions.

The copyedit improves clarity by explicitly mentioning when rebooting might be needed (firmware update or frozen device).

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@USER_GUIDE.md`:
- Line 151: Clarify the ambiguous "UI Font Size" setting: decide whether it
controls interface chrome or reading content and update the wording
accordingly—either rename the setting to "Reader Font Size" throughout
documentation and UI labels (change all occurrences of "UI Font Size") if it
only affects reading mode, or keep "UI Font Size" but change its description to
explicitly state it affects both the UI and reader text (e.g., "Adjust the font
size for the application UI and reading content") so users aren’t confused;
ensure the chosen term and description are consistent across USER_GUIDE.md and
any settings screens.
- Line 153: Update the phrasing in the "Reader Screen Margin" bullet: change "5
pixel increments" to the hyphenated compound adjective "5-pixel increments" so
the line reads "**Reader Screen Margin**: Controls the screen margins in reader
mode between 5 and 40 pixels in 5-pixel increments." Locate the text under the
"Reader Screen Margin" heading in USER_GUIDE.md and apply this single-word
hyphenation fix.
- Line 184: The "Time to Sleep" option list has inconsistent/incorrect
quotation: fix the list in the USER_GUIDE.md line containing "Time to Sleep" so
each option is quoted individually (e.g., change '"1 min", "5 min", "10 min, "15
min", and "30 min"' to '"1 min", "5 min", "10 min", "15 min", and "30 min"') so
every option has matching opening and closing quotes.

---

Nitpick comments:
In `@USER_GUIDE.md`:
- Line 17: Update the Table of Contents entry for "3.5 Settings" to include the
new subsections so links appear for 3.5.1–3.5.4; specifically, beneath the
existing "- [3.5 Settings](`#35-settings`)" TOC line add entries for "- [3.5.1
Display](`#351-display`)", "- [3.5.2 Reader](`#352-reader`)", "- [3.5.3
Controls](`#353-controls`)", and "- [3.5.4 System](`#354-system`)" (matching the
section headings' anchor formats) so readers can navigate directly to each
Settings subsection.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
USER_GUIDE.md (1)

116-123: ⚠️ Potential issue | 🟡 Minor

Fix multiple copy/typo issues in Display settings bullets.

I spotted a few small errors that will read poorly in user docs:

  • “fallbacks” → “falls back”
  • “try to to” → “try to”
  • “white&black” → “black-and-white” (or “black & white”)
  • “pecentage” → “percentage”
✏️ Proposed edits
-  - "Cover + Custom" - The book cover image, fallbacks to "Custom" behavior
+  - "Cover + Custom" - The book cover image, falls back to "Custom" behavior
...
-  - "Crop" - Scale the image down and crop as necessary to try to to fill the screen (Note: this is experimental and may not work as expected)
+  - "Crop" - Scale the image down and crop as necessary to try to fill the screen (Note: this is experimental and may not work as expected)
...
-  - "Inverted" - The image will be inverted as in white&black and will be displayed without grayscale conversion
+  - "Inverted" - The image will be inverted in black & white and will be displayed without grayscale conversion
...
-- **Hide Battery %**: Configure where to suppress the battery pecentage display in the status bar; the battery icon will still be shown:
+- **Hide Battery %**: Configure where to suppress the battery percentage display in the status bar; the battery icon will still be shown:

Also applies to: 131-131

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@USER_GUIDE.md` around lines 116 - 123, Fix the copy/typo issues in the
Display settings bullets under the "Sleep Screen Cover Mode" and "Sleep Screen
Cover Filter" sections: change "fallbacks" to "falls back" in the "Cover +
Custom" line, remove the duplicated word in "try to to" to "try to", replace
"white&black" with "black-and-white" (or "black & white") in the filter
descriptions, and correct any "pecentage" typos to "percentage" (also check the
same wording around line 131). Update the corresponding bullet texts for "Fit",
"Crop", and the three filter options so the phrasing is grammatically correct
and consistent.
🧹 Nitpick comments (1)
USER_GUIDE.md (1)

13-18: Add Settings subsections to the Table of Contents for navigability.

The new 3.5.x subsections are present in the document but not listed in the TOC. Consider adding 3.5.1–3.5.4 entries under Settings so users can jump directly to Display/Reader/Controls/System.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@USER_GUIDE.md` around lines 13 - 18, The Table of Contents is missing the new
Settings subsections; update the TOC entry for "3.5 Settings" to include
3.5.1–3.5.4 so users can jump to Display, Reader, Controls, and System; locate
the "3.5 Settings" heading and add four sub-entries named "3.5.1 Display",
"3.5.2 Reader", "3.5.3 Controls", and "3.5.4 System" (matching the existing
document subsection headings) beneath it in the TOC.
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4e037ab and a7f43ed.

📒 Files selected for processing (1)
  • USER_GUIDE.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-02-19T12:17:05.421Z
Learnt from: Uri-Tauber
Repo: crosspoint-reader/crosspoint-reader PR: 988
File: lib/Epub/Epub/parsers/ChapterHtmlSlimParser.cpp:649-661
Timestamp: 2026-02-19T12:17:05.421Z
Learning: In ChapterHtmlSlimParser.cpp, when computing footnote word indices in endElement() for footnote links, the wordIndex must be cumulative across the 750-word mid-paragraph flush boundary. The correct calculation is: `wordIndex = wordsExtractedInBlock + currentTextBlock->size()`, not just `currentTextBlock->size()`. This ensures footnotes attach to the page containing their actual anchor word, even after layoutAndExtractLines(false) has extracted and removed earlier words from the block.

Applied to files:

  • USER_GUIDE.md
🪛 LanguageTool
USER_GUIDE.md

[style] ~154-~154: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...nd 40 pixels in 5-pixel increments. - Reader Paragraph Alignment: Set the alignmen...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build
  • GitHub Check: cppcheck
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@USER_GUIDE.md`:
- Around line 177-180: Update the "Short Power Button Click" entry: change the
"Sleep" description from "A short press powers the device off" to something that
matches actual behavior, e.g. "A short press puts the device to sleep (enters
deep sleep with GPIO wakeup)" so the label "Sleep" and the text accurately
reflect deep sleep rather than hard power-off.

---

Outside diff comments:
In `@USER_GUIDE.md`:
- Around line 116-123: Fix the copy/typo issues in the Display settings bullets
under the "Sleep Screen Cover Mode" and "Sleep Screen Cover Filter" sections:
change "fallbacks" to "falls back" in the "Cover + Custom" line, remove the
duplicated word in "try to to" to "try to", replace "white&black" with
"black-and-white" (or "black & white") in the filter descriptions, and correct
any "pecentage" typos to "percentage" (also check the same wording around line
131). Update the corresponding bullet texts for "Fit", "Crop", and the three
filter options so the phrasing is grammatically correct and consistent.

---

Duplicate comments:
In `@USER_GUIDE.md`:
- Line 150: The “UI Font Size” entry is ambiguous about whether it changes
application chrome or the reader's article text; update the wording for the "UI
Font Size" setting to explicitly state which it controls (e.g., "Adjust the
interface text size (menus, buttons, labels)" if it affects UI chrome, or
"Adjust the reader text size (article/content body)" if it affects reading
content), keep the listed options ("Small", "Medium", "Large", "X Large"), and
ensure any related mentions elsewhere (settings descriptions or tooltips) use
the same clarified phrasing to avoid confusion.

---

Nitpick comments:
In `@USER_GUIDE.md`:
- Around line 13-18: The Table of Contents is missing the new Settings
subsections; update the TOC entry for "3.5 Settings" to include 3.5.1–3.5.4 so
users can jump to Display, Reader, Controls, and System; locate the "3.5
Settings" heading and add four sub-entries named "3.5.1 Display", "3.5.2
Reader", "3.5.3 Controls", and "3.5.4 System" (matching the existing document
subsection headings) beneath it in the TOC.

@divinitycove divinitycove marked this pull request as draft February 23, 2026 00:36
@divinitycove divinitycove marked this pull request as ready for review February 23, 2026 02:22
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a7f43ed and ef45c0e.

📒 Files selected for processing (1)
  • USER_GUIDE.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-02-19T12:17:05.421Z
Learnt from: Uri-Tauber
Repo: crosspoint-reader/crosspoint-reader PR: 988
File: lib/Epub/Epub/parsers/ChapterHtmlSlimParser.cpp:649-661
Timestamp: 2026-02-19T12:17:05.421Z
Learning: In ChapterHtmlSlimParser.cpp, when computing footnote word indices in endElement() for footnote links, the wordIndex must be cumulative across the 750-word mid-paragraph flush boundary. The correct calculation is: `wordIndex = wordsExtractedInBlock + currentTextBlock->size()`, not just `currentTextBlock->size()`. This ensures footnotes attach to the page containing their actual anchor word, even after layoutAndExtractLines(false) has extracted and removed earlier words from the block.

Applied to files:

  • USER_GUIDE.md
🪛 LanguageTool
USER_GUIDE.md

[grammar] ~96-~96: Ensure spelling is correct
Context: ...l start hosting a web server. See the webserver docs for more inf...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[style] ~163-~163: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...nd 40 pixels in 5-pixel increments. - Reader Paragraph Alignment: Set the alignmen...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~235-~235: ‘by mistake’ might be wordy. Consider a shorter alternative.
Context: ...rols)** to help avoid changing chapters by mistake. ### System Navigation * **Return to ...

(EN_WORDINESS_PREMIUM_BY_MISTAKE)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build
🔇 Additional comments (8)
USER_GUIDE.md (8)

13-23: TOC updates look consistent with new section structure.


44-44: Control Settings cross‑reference is clear.


58-60: Power button behavior and reboot guidance read well.


75-111: Screens section reordering and new screen descriptions read clearly.


117-153: Display settings expansion is clear and well‑structured.


161-198: Reader / Controls / System settings updates are consistent and easy to follow.


200-209: Sleep Screen section intro remains clear after renumbering.


227-241: Reading Mode navigation clarifications are crisp and match the new screen names.

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@USER_GUIDE.md`:
- Around line 154-160: The "UI Font Size" label is misleading because it reads
like UI chrome but the description says it adjusts reading text; update the
USER_GUIDE.md "Reader" section so label and description match (either rename "UI
Font Size" to "Reading Text Size" or change the description to state it adjusts
UI chrome and reading text if intended). Specifically update the "Reader Font
Family" / "UI Font Size" entries to use a consistent term (e.g., "Reading Text
Size") and ensure the explanatory line clearly states whether the sizes apply to
the reader content, the app chrome, or both so users are not confused.

@divinitycove
Copy link
Contributor Author

Apologies for the preemptive publishing of the PR, it's been literal years since I've done git editing so hopefully everything has turned out alright. I'm going to hold off from any further edits/tweaks and say that this is good enough for now, and that USER_GUIDE.md now for the most part matches 1.1.0.

The only things in particular I'd like to be checked would be the the UI Theme, Embedded Style, Hyphenation, and Clear Reading Cache setting descriptions, especially Embedded Style and Clear Reading Cache, as they might need to be more technically specific.

It would also be helpful if someone could point me in the direction of whatever file is used to determine the default settings, as I'm unsure of which is which and want to add the default for settings which are missing that information.

Otherwise, I'm hoping that this PR can be merged relatively quickly, as USER_GUIDE.md was already outdated for 1.0.0, and with image support now added I assume that Crosspoint will have an influx of users updating or switching over.

znelson
znelson previously approved these changes Feb 23, 2026
Copy link
Contributor

@znelson znelson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks!

Add default value to Time to Sleep

Co-authored-by: Zach Nelson <[email protected]>
@znelson znelson merged commit 75bb1d8 into crosspoint-reader:master Feb 23, 2026
5 checks passed
lukestein pushed a commit to lukestein/crosspoint-reader that referenced this pull request Feb 23, 2026
## Summary

* **What is the goal of this PR?** (e.g., Implements the new feature for
file uploading.)
- This PR updates the USER_GUIDE.md to match recent changes, in
particular 1.1.0, alongside some minor copyediting.
* **What changes are included?**

  - Renamed titles for screens to match current UI.
- Sorted Settings section by order in UI, added subheadings for Settings
pages, and added all current settings.
  - Updated System Navigation behaviour description to match crosspoint-reader#726.

## Additional Context

* Add any other information that might be helpful for the reviewer
(e.g., performance implications, potential risks,
  specific areas to focus on).

This is an admittedly quick edit I did to get USER_GUIDE.md up to
scratch alongside the release of 1.1.0. I'm a writer, not a programmer,
so there are some things that will probably need improvement.

- ~Recent Books needs to be added, something I could add to this PR if
needed.~
- ~Remap Front Buttons might need to be updated.~

These have been added in later commits, Remap Front Buttons might still
need more detail.

- The UI Theme, Embedded Style, Hyphenation, WiFi Networks, KOReader
Sync, and Clear Reading Cache settings might need better (or more
technically specific) descriptions.

Two questions I have:
- ~Should the new Settings subheadings be added to the Table of
Contents?~ Added in later commits.
- The Manual of Style/formatting for USER_GUIDE.md, especially in the
Settings section, is somewhat inconsistent. Let me know if any of my
edits don't fit with this.

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**< YES | PARTIALLY | NO
>**_
NO

---------

Co-authored-by: Zach Nelson <[email protected]>
songhyun-k pushed a commit to songhyun-k/crosspoint-reader-kimchi that referenced this pull request Feb 24, 2026
## Summary

* **What is the goal of this PR?** (e.g., Implements the new feature for
file uploading.)
- This PR updates the USER_GUIDE.md to match recent changes, in
particular 1.1.0, alongside some minor copyediting.
* **What changes are included?**

  - Renamed titles for screens to match current UI.
- Sorted Settings section by order in UI, added subheadings for Settings
pages, and added all current settings.
  - Updated System Navigation behaviour description to match crosspoint-reader#726.

## Additional Context

* Add any other information that might be helpful for the reviewer
(e.g., performance implications, potential risks,
  specific areas to focus on).

This is an admittedly quick edit I did to get USER_GUIDE.md up to
scratch alongside the release of 1.1.0. I'm a writer, not a programmer,
so there are some things that will probably need improvement.

- ~Recent Books needs to be added, something I could add to this PR if
needed.~
- ~Remap Front Buttons might need to be updated.~

These have been added in later commits, Remap Front Buttons might still
need more detail.

- The UI Theme, Embedded Style, Hyphenation, WiFi Networks, KOReader
Sync, and Clear Reading Cache settings might need better (or more
technically specific) descriptions.

Two questions I have:
- ~Should the new Settings subheadings be added to the Table of
Contents?~ Added in later commits.
- The Manual of Style/formatting for USER_GUIDE.md, especially in the
Settings section, is somewhat inconsistent. Let me know if any of my
edits don't fit with this.

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**< YES | PARTIALLY | NO
>**_
NO

---------

Co-authored-by: Zach Nelson <[email protected]>
(cherry picked from commit 75bb1d8)
lukestein pushed a commit to lukestein/crosspoint-reader that referenced this pull request Feb 24, 2026
## Summary

* **What is the goal of this PR?** (e.g., Implements the new feature for
file uploading.)
- This PR updates the USER_GUIDE.md to match recent changes, in
particular 1.1.0, alongside some minor copyediting.
* **What changes are included?**

  - Renamed titles for screens to match current UI.
- Sorted Settings section by order in UI, added subheadings for Settings
pages, and added all current settings.
  - Updated System Navigation behaviour description to match crosspoint-reader#726.

## Additional Context

* Add any other information that might be helpful for the reviewer
(e.g., performance implications, potential risks,
  specific areas to focus on).

This is an admittedly quick edit I did to get USER_GUIDE.md up to
scratch alongside the release of 1.1.0. I'm a writer, not a programmer,
so there are some things that will probably need improvement.

- ~Recent Books needs to be added, something I could add to this PR if
needed.~
- ~Remap Front Buttons might need to be updated.~

These have been added in later commits, Remap Front Buttons might still
need more detail.

- The UI Theme, Embedded Style, Hyphenation, WiFi Networks, KOReader
Sync, and Clear Reading Cache settings might need better (or more
technically specific) descriptions.

Two questions I have:
- ~Should the new Settings subheadings be added to the Table of
Contents?~ Added in later commits.
- The Manual of Style/formatting for USER_GUIDE.md, especially in the
Settings section, is somewhat inconsistent. Let me know if any of my
edits don't fit with this.

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**< YES | PARTIALLY | NO
>**_
NO

---------

Co-authored-by: Zach Nelson <[email protected]>
lukestein pushed a commit to lukestein/crosspoint-reader that referenced this pull request Feb 24, 2026
## Summary

* **What is the goal of this PR?** (e.g., Implements the new feature for
file uploading.)
- This PR updates the USER_GUIDE.md to match recent changes, in
particular 1.1.0, alongside some minor copyediting.
* **What changes are included?**

  - Renamed titles for screens to match current UI.
- Sorted Settings section by order in UI, added subheadings for Settings
pages, and added all current settings.
  - Updated System Navigation behaviour description to match crosspoint-reader#726.

## Additional Context

* Add any other information that might be helpful for the reviewer
(e.g., performance implications, potential risks,
  specific areas to focus on).

This is an admittedly quick edit I did to get USER_GUIDE.md up to
scratch alongside the release of 1.1.0. I'm a writer, not a programmer,
so there are some things that will probably need improvement.

- ~Recent Books needs to be added, something I could add to this PR if
needed.~
- ~Remap Front Buttons might need to be updated.~

These have been added in later commits, Remap Front Buttons might still
need more detail.

- The UI Theme, Embedded Style, Hyphenation, WiFi Networks, KOReader
Sync, and Clear Reading Cache settings might need better (or more
technically specific) descriptions.

Two questions I have:
- ~Should the new Settings subheadings be added to the Table of
Contents?~ Added in later commits.
- The Manual of Style/formatting for USER_GUIDE.md, especially in the
Settings section, is somewhat inconsistent. Let me know if any of my
edits don't fit with this.

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**< YES | PARTIALLY | NO
>**_
NO

---------

Co-authored-by: Zach Nelson <[email protected]>
el pushed a commit to el/crosspoint-reader that referenced this pull request Feb 24, 2026
## Summary

* **What is the goal of this PR?** (e.g., Implements the new feature for
file uploading.)
- This PR updates the USER_GUIDE.md to match recent changes, in
particular 1.1.0, alongside some minor copyediting.
* **What changes are included?**

  - Renamed titles for screens to match current UI.
- Sorted Settings section by order in UI, added subheadings for Settings
pages, and added all current settings.
  - Updated System Navigation behaviour description to match crosspoint-reader#726.

## Additional Context

* Add any other information that might be helpful for the reviewer
(e.g., performance implications, potential risks,
  specific areas to focus on).

This is an admittedly quick edit I did to get USER_GUIDE.md up to
scratch alongside the release of 1.1.0. I'm a writer, not a programmer,
so there are some things that will probably need improvement.

- ~Recent Books needs to be added, something I could add to this PR if
needed.~
- ~Remap Front Buttons might need to be updated.~

These have been added in later commits, Remap Front Buttons might still
need more detail.

- The UI Theme, Embedded Style, Hyphenation, WiFi Networks, KOReader
Sync, and Clear Reading Cache settings might need better (or more
technically specific) descriptions.

Two questions I have:
- ~Should the new Settings subheadings be added to the Table of
Contents?~ Added in later commits.
- The Manual of Style/formatting for USER_GUIDE.md, especially in the
Settings section, is somewhat inconsistent. Let me know if any of my
edits don't fit with this.

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**< YES | PARTIALLY | NO
>**_
NO

---------

Co-authored-by: Zach Nelson <[email protected]>
el pushed a commit to el/crosspoint-reader that referenced this pull request Feb 24, 2026
## Summary

* **What is the goal of this PR?** (e.g., Implements the new feature for
file uploading.)
- This PR updates the USER_GUIDE.md to match recent changes, in
particular 1.1.0, alongside some minor copyediting.
* **What changes are included?**

  - Renamed titles for screens to match current UI.
- Sorted Settings section by order in UI, added subheadings for Settings
pages, and added all current settings.
  - Updated System Navigation behaviour description to match crosspoint-reader#726.

## Additional Context

* Add any other information that might be helpful for the reviewer
(e.g., performance implications, potential risks,
  specific areas to focus on).

This is an admittedly quick edit I did to get USER_GUIDE.md up to
scratch alongside the release of 1.1.0. I'm a writer, not a programmer,
so there are some things that will probably need improvement.

- ~Recent Books needs to be added, something I could add to this PR if
needed.~
- ~Remap Front Buttons might need to be updated.~

These have been added in later commits, Remap Front Buttons might still
need more detail.

- The UI Theme, Embedded Style, Hyphenation, WiFi Networks, KOReader
Sync, and Clear Reading Cache settings might need better (or more
technically specific) descriptions.

Two questions I have:
- ~Should the new Settings subheadings be added to the Table of
Contents?~ Added in later commits.
- The Manual of Style/formatting for USER_GUIDE.md, especially in the
Settings section, is somewhat inconsistent. Let me know if any of my
edits don't fit with this.

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**< YES | PARTIALLY | NO
>**_
NO

---------

Co-authored-by: Zach Nelson <[email protected]>
el pushed a commit to el/crosspoint-reader that referenced this pull request Feb 24, 2026
## Summary

* **What is the goal of this PR?** (e.g., Implements the new feature for
file uploading.)
- This PR updates the USER_GUIDE.md to match recent changes, in
particular 1.1.0, alongside some minor copyediting.
* **What changes are included?**

  - Renamed titles for screens to match current UI.
- Sorted Settings section by order in UI, added subheadings for Settings
pages, and added all current settings.
  - Updated System Navigation behaviour description to match crosspoint-reader#726.

## Additional Context

* Add any other information that might be helpful for the reviewer
(e.g., performance implications, potential risks,
  specific areas to focus on).

This is an admittedly quick edit I did to get USER_GUIDE.md up to
scratch alongside the release of 1.1.0. I'm a writer, not a programmer,
so there are some things that will probably need improvement.

- ~Recent Books needs to be added, something I could add to this PR if
needed.~
- ~Remap Front Buttons might need to be updated.~

These have been added in later commits, Remap Front Buttons might still
need more detail.

- The UI Theme, Embedded Style, Hyphenation, WiFi Networks, KOReader
Sync, and Clear Reading Cache settings might need better (or more
technically specific) descriptions.

Two questions I have:
- ~Should the new Settings subheadings be added to the Table of
Contents?~ Added in later commits.
- The Manual of Style/formatting for USER_GUIDE.md, especially in the
Settings section, is somewhat inconsistent. Let me know if any of my
edits don't fit with this.

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**< YES | PARTIALLY | NO
>**_
NO

---------

Co-authored-by: Zach Nelson <[email protected]>
el pushed a commit to el/crosspoint-reader that referenced this pull request Feb 24, 2026
## Summary

* **What is the goal of this PR?** (e.g., Implements the new feature for
file uploading.)
- This PR updates the USER_GUIDE.md to match recent changes, in
particular 1.1.0, alongside some minor copyediting.
* **What changes are included?**

  - Renamed titles for screens to match current UI.
- Sorted Settings section by order in UI, added subheadings for Settings
pages, and added all current settings.
  - Updated System Navigation behaviour description to match crosspoint-reader#726.

## Additional Context

* Add any other information that might be helpful for the reviewer
(e.g., performance implications, potential risks,
  specific areas to focus on).

This is an admittedly quick edit I did to get USER_GUIDE.md up to
scratch alongside the release of 1.1.0. I'm a writer, not a programmer,
so there are some things that will probably need improvement.

- ~Recent Books needs to be added, something I could add to this PR if
needed.~
- ~Remap Front Buttons might need to be updated.~

These have been added in later commits, Remap Front Buttons might still
need more detail.

- The UI Theme, Embedded Style, Hyphenation, WiFi Networks, KOReader
Sync, and Clear Reading Cache settings might need better (or more
technically specific) descriptions.

Two questions I have:
- ~Should the new Settings subheadings be added to the Table of
Contents?~ Added in later commits.
- The Manual of Style/formatting for USER_GUIDE.md, especially in the
Settings section, is somewhat inconsistent. Let me know if any of my
edits don't fit with this.

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**< YES | PARTIALLY | NO
>**_
NO

---------

Co-authored-by: Zach Nelson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants