Skip to content

v2.5.4

Choose a tag to compare

@AltanS AltanS released this 09 Oct 14:13
· 169 commits to main since this release

Docs only. Long docs get a contents list at the top.

Docs

  • README.md and every doc over 150 lines (22 files in docs/) start with a generated "Contents" list of their ## and ### headings. The anchors follow GitHub's slug rules.
  • make toc rewrites the lists after a docs edit. scripts/docs-toc.py --check and tests/test_docs_toc.py fail when a list does not match its headings.
  • Fixed a broken anchor link in docs/features.md (reconciler check mode).

Upgrade notes

  • None. No code that runs on a box changed. After you edit a heading in a long doc, run make toc.