#487 Help pages describe themselves in their own words
–
- github
- github/openchronology/timeline-app
- github/openchronology/timeline-app#487
- pull request
- state:merged
Closes #470. A help page's description was the first 200 characters of its document. 26 of 33 were cut mid-word, `/help/syslog` began "server/syslog-receiver.mjs listens…", `/help/administration` had none, and `/help/seeding` was "After building and migrating the platform, run:". **Changes:** - **A description per document:** each document in `docs/` has one, written from its own sections and under 160 characters. It's an HTML comment under the title, which GitHub doesn't show: ` `. - **Where it's used:** `server/help.mjs` reads it for the page's meta description and the help's list of pages. It keeps the comment out of the rendered page and out of help search. - **Fallback:** a document without one is summarized by its first sentences that fit in 160 characters, or its first sentence cut between words (`firstSentences`). - **Titles:** help pages' titles use `pageTitle` (#469, which fits them to search results once merged). **Tests:** `help.test.mjs` checks that every page's summary is 40–160 characters and doesn't start with a path. It also checks that the comment shows nowhere, and covers the fallback. Unit tests pass, except `contents.test.mjs`, which fails on `main` in this checkout as well. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_011fFY8eruEi1xAkkMBni13B https://github.com/openchronology/timeline-app/pull/487
Related
Open #487 Help pages describe themselves in their own words in the timeline