Skip to content

anchored-docs v2.1.0

Choose a tag to compare

@github-actions github-actions released this 12 Oct 15:14
· 2 commits to main since this release
7282bf8
  • New: the bundle lives in docs/anchored-docs/. The prose and the scripts use this path. The project's own docs/ folder is free for other files.
  • New: docs_check.mjs migrate <repo> [--apply] moves a 2.0 bundle to docs/anchored-docs/, rewrites the links that point at it, regenerates _map.json, and logs the move. A dry run is the default. A second run changes nothing. A conflict stops the run before a file moves. Read references/migrate.md.
  • New: until a repository runs migrate, the scripts continue to find its bundle in docs/. When ste_check.mjs --glossary-report finds it there, it prints a notice that names the migrate command.
  • Changed: docs/tickets/ stays adjacent to the bundle, not in the bundle. It keeps its .gitignore entry.
  • Changed: ste_check.mjs no longer names docs/_glossary.json in its messages. It names the project glossary in the bundle.
  • Changed: with a bundle at docs/anchored-docs/, docs_check.mjs uses the repository root as two levels above the bundle. So sources paths resolve without --repo. Before, the root was the parent of the bundle folder.
  • Changed: for a source file, ste_check.mjs finds the project glossary in docs/anchored-docs/ first, then in docs/.
  • Changed: the help text of docs_check.mjs names docs/anchored-docs/ and lists migrate. The ste_check.mjs --glossary-report example names docs/anchored-docs/.
  • New: when docs_check.mjs gets docs/anchored-docs/ and that folder is missing, but docs/ holds a 2.0 bundle, it prints where the bundle is.