Repository navigation
Conversation
gen-doc reference for the storage, extraction and paper-parse schemas, the guides and crosswalks staged with rewritten links, mkdocs-material, and a docs workflow that builds with --strict on pull requests and deploys on main. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…e docs build Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
jdkent
marked this pull request as ready for review
October 21, 2026 02:01
jdkent
added a commit
that referenced
this pull request
Oct 21, 2026
Docs site: render the generated reference pages (follow-up to #48)
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
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.
Publishes https://neurostuff.github.io/study_schema/ (Pages is already enabled with build_type workflow).
What
tools/build_docs.pyruns LinkMLgen-docon the storage, extraction and paper-parse schemas (every class, slot and enum, with links and mermaid diagrams; the evidence schema is imported by extraction and documented with it) intobuild/docs/reference/<schema>/, and stages the guides beside it.build/is git-ignored; nothing generated is committed.mkdocs.yml(mkdocs-material, search on). Navigation: Home (README), Guides (schema tutorial, analysis entities, representing models, storage design notes, extraction schema), Crosswalks (standards, ARS), Reference (storage, extraction, paper parse). Class, slot and enum pages are reachable from each reference index and from search.docsextra inpyproject.toml(mkdocs>=1.6,<2,mkdocs-material>=9.5,linkml>=1.12). mkdocs is held below 2 because Material warns that 2.0 drops plugins and theme overrides..github/workflows/docs.yml: pull requests build withmkdocs build --strict; pushes to main build, then deploy withupload-pages-artifactanddeploy-pages(deploy job haspages: write,id-token: write,contents: read; apagesconcurrency group).contracts.ymlis untouched.Links. The script rewrites links while staging the guides, so the markdown keeps working on GitHub: README becomes the home page, links to a schema directory go to its reference index, other repository files go to GitHub. A link to a file that does not exist is left alone, so
mkdocs build --strictfails on it. Five such links in the guides (the expressivity probe, the multivariate probe, the ONVOC audit,test_effect_kind_derivation.py, a corrections JSON) were removed at the source; two of them were rows in the README's table of documents.Checked. Built on a fresh clone with a fresh venv:
build_docs.pythenmkdocs build --strictpasses. Read the rendered Analysis class page (mermaid class diagram, slot links), the AnalysisType enum page and the schema tutorial (guide-to-guide and reference links).Notes
analysis.mdand a classAnalysis.mdin the same folder, so a local preview on a case-insensitive filesystem would collide; the Linux CI build is unaffected.Nonein the Meaning column of enums whose values have nomeaning.🤖 Generated with Claude Code