docs: Bring documentation (fully) up to date#615
Open
bencap wants to merge 2 commits intorelease-2026.2.0from
Open
docs: Bring documentation (fully) up to date#615bencap wants to merge 2 commits intorelease-2026.2.0from
bencap wants to merge 2 commits intorelease-2026.2.0from
Conversation
Add MkDocs Material documentation site under docs/ with full content covering Getting Started, Finding Data, Submitting Data, MaveMD, Programmatic Access, Reference, Troubleshooting, FAQ, and Citations. Enhance docs with screenshots, Mermaid diagrams, admonitions, abbreviation tooltips, code copy buttons, and instant navigation. Add scripts/build-docs.sh to build MkDocs and copy output to public/docs/mavedb/ for inclusion in the Vite production bundle. Docs are served at /docs/mavedb/ to match the legacy Sphinx URL path. The build script runs automatically in npm run build and npm run preview. Add npm run docs for local docs development. Update all Vue component doc links in ScoreSetCreator and DocumentationView to point to the new /docs/mavedb/ paths. Remove old Sphinx HTML files from public/docs/mavedb/, RST sources from src/docs/, Sphinx dependencies from requirements.txt, and .doctrees entry from .gitignore.
Collaborator
Author
Summary
Test plan
AI Involvement
|
Collaborator
Author
|
We might consider removing built docs from source control, given we already track content in the |
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.
reopens the erroneously closed #609. This PR fills in incomplete pages which were punted as part of #613.