Skip to content

docs: humanize prose across all pages - #156

Merged
gantoine merged 2 commits into
mainfrom
docs/humanize-all
Sep 28, 2026
Merged

gantoine merged 2 commits into
mainfrom
docs/humanize-all

Conversation

@gantoine

@gantoine gantoine commented Sep 28, 2026 •

Copy link
Copy Markdown
Member

Runs the vendored humanizer skill over every page under docs/ (snippets and Navigation.md excluded). The edits are light: 83 of 93 pages changed, and the diff is +383/−393 lines.

Main fixes:

  • decorative bold, em/en dashes and prose semicolons
  • choppy fragments, and . See [X] rewritten as (see [X])
  • staged openers, exclamation closers and sales language (mostly on index.md and metadata-providers.md)
  • a few typos found along the way

Front matter, headings, admonition/tab/include syntax, code, link targets and UI labels are unchanged. I checked this by diffing every link target and inline-code span before and after.

trunk check is clean and mkdocs build --strict passes. The strict build was run with the social-cards plugin disabled because libcairo is missing locally, and CI covers that plugin.

A second commit fixes content bugs found during the pass. Each was checked against rommapp/romm master or the GitHub license API:

  • administration/scanning-and-watcher.md: the watcher delay defaults to 5 minutes (RESCAN_ON_FILESYSTEM_CHANGE_DELAY in backend/config/__init__.py, applied as timedelta(minutes=...) in watcher.py), not 10 seconds.
  • ecosystem/first-party-apps.md and using/account-and-profile.md: client API tokens are rmm_ plus token_hex(32), which is 68 characters, not 44.
  • about/license.md: argosy-launcher and playnite-plugin are GPLv3, not AGPLv3, and the "more permissive" wording is gone. In index.md, GPLv3 is no longer called "permissive", and MIT (grout) is now listed.
  • administration/firmware-management.md: the !!! important body is now indented, so it renders inside the box.
  • about/faqs.md: "Where's can I find you?" is now "Where can I find you?". Nothing links to the old anchor.

🤖 Generated with Claude Code

gantoine and others added 2 commits September 27, 2026 20:10
Run the humanizer skill over every page under docs/ (snippets and
Navigation.md excluded). Removes decorative bold, dashes, choppy
fragments, staged openers, sales language and exclamation closers.
Front matter, headings, MkDocs syntax, code, links and UI labels are
unchanged.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Checked against rommapp/romm master:
- watcher delay defaults to 5 minutes (backend/config/__init__.py), not 10 seconds
- client API tokens are rmm_ + 64 hex = 68 chars (handler/auth/base_handler.py), not 44
- argosy-launcher and playnite-plugin are GPLv3, not AGPLv3, and GPLv3 is not permissive
- indent the firmware legality admonition body so it renders inside the box
- fix the "Where's can I find you?" FAQ heading typo

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@gantoine
gantoine merged commit 34a20ff into main Sep 28, 2026
4 checks passed
@gantoine
gantoine deleted the docs/humanize-all branch September 28, 2026 14:00
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.

1 participant