docs: slim index hub, cut em-dash spam, fix flat docs-html README links #86
Loading…
Reference in a new issue
No description provided.
Delete branch "docs/index-polish"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Owner feedback, three parts:
1.
docs/index.mdredundancy + broken README link[README](../README.md)link rendered broken in compiled docs-html because every page compiles flat intodocs-html/, so../README.mdpointed outside the site.2. Em-dash overuse
README.mdanddocs/*.md: 76 em dashes down to 7, and the 7 that remain are all inside code blocks (mermaid diagrams, the repo-layout block, a shell comment) that must stay byte-identical. Dashes became commas, colons, parentheses, semicolons or restructured sentences; no technical content, links, image paths or code blocks changed.3. Consistency
Build change (filter)
.tern/docs-html.lua, wired into thepandoc/docsprofile options in.tern/config.toml(between the mermaid filter andmd-links.lua). It runs on docs pages only and rewrites link targets beforemd-links.luaswaps the extension:../README.mdandREADME.md→README.md(→ siblingREADME.html)docs/*.mdself-references →*.md(→ sibling*.html)pandoc/readmeprofile and.tern/readme-html.luaare untouched;docs-html/README.html's link/image treatment is verified byte-identical to master. Raw markdown keeps plain repo paths (../README.mdindocs/index.mdis correct on the forge); the filter only affects compiled docs-html. The filter lives directly in.tern/(not.tern/data/) sotern --updatecannot wipe it.Verification
tern --update+ternclean;docs-html/index.htmlREADME link ishref="README.html"(same directory).../README*orhref="docs/…"targets left anywhere indocs-html/.README.htmlhref/src sets identical to master's build (docs pages carry no<img>after the table removal; mermaid script src only).Closes nothing; implements the owner's review feedback on docs structure, dash usage and the compiled-docs link fix.