Fix subject-format doc path in the validate endpoints#1036
Closed
malberts wants to merge 4 commits into
Closed
Conversation
… extending The single reference/ directory mixed docs for very different readers — wikitext/Lua authors, HTTP API integrators, RDF/ontology practitioners, and extension developers — under one flat, unlabelled list. Split it into audience-scoped directories so the sidebar and the docs landing page can each signpost a reader to the right surface: - authoring/ — parser-functions, lua-api (wikitext + Lua on the wiki) - api/ — rest-api, query-api, schema-format, subject-format, validation-codes, graph-model - rdf/ — rdf-export, ontology-mapping (with a forward link to the person-to-edm example) - extending/ — extending Also: - Rewrite docs/README.md as a goal-based router (learn the model / build on your wiki / integrate over HTTP / publish as RDF / extend / run / architecture), with live-sandbox and install pointers up top. - Give query-api and validation-codes the title/order frontmatter they were missing, so they sort correctly in the website sidebar instead of dangling at the end. - Fix all in-tree links to the moved files (ADRs, planning docs, glossary, the example). - Update RestApiDocsCoverageTest and two REST param descriptions that referenced the moved rest-api.md / subject-format.md paths. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The Glossary lived at docs/Glossary.md until #825 moved it into a concepts/ directory "ahead of publishing it on the VitePress site". The website's sidebar builder can only group directories, so the docs grew a one-file directory to satisfy the tool. That is the tool dictating the structure. It is also a category error in the new layout: every other directory is an audience or surface (authoring, api, rdf, extending) or a genre serving one (examples, operations, adr). The Glossary is neither. It is the shared vocabulary underneath all of them, the one doc every audience reads first, and the most-linked doc in the project. Filing it as a peer of the audience directories implies it is one more surface you might skip. Back to docs/glossary.md, so it reads as the prerequisite it is and gets the URL it deserves (/docs/glossary). The website side teaches the sidebar to render top-level docs as ungrouped links, which is a rule rather than a special case. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The docs reorganisation moved glossary.md to the docs root and extending.md/lua-api.md into audience directories, but three links that live outside docs/ still pointed at the old paths, so the docs-tree link check did not catch them: - README.md linked to docs/concepts/glossary.md - tests/RedHerb/README.md linked to docs/reference/extending.md - DemoData/Page/Developers.wikitext linked (by absolute master URL) to docs/reference/lua-api.md Point each at its new location. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The validate and validate-update endpoints pointed their statements param at docs/SubjectFormat.md, a path that does not exist. The create and replace endpoints already reference docs/api/subject-format.md; point the validate pair at the same doc so all four subject endpoints agree. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Member
|
Closing in favor of #1037 because it has a doc drift test |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follows-up to #1034 (based on its branch).
ValidateSubjectApiandValidateSubjectUpdateApipoint theirstatementsparam description atdocs/SubjectFormat.md, a path that has never existed (it predates the docs reorganisation). Thecreateandreplaceendpoints already referencedocs/api/subject-format.md; this points the validate pair at the same doc,so all four subject endpoints agree.
Based on the #1034 branch because that is where
docs/api/subject-format.mdlives (onmasterthe doc is still atdocs/reference/subject-format.md), so the fix lands together with the reorg and needs no re-touch afterwards.