Repository navigation
Lay docs/ out as the website's documentation, one source for both - #19
Merged
Merged
Conversation
The guide pages follow maimanstudio.com/docs page for page, docs/nav.yml is the sidebar, the component reference and API page are generated from the code, and tests hold the generated pages, the sidebar and every relative link. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015NAUQm8LQftjtRw8cqdSq7
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
2 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.
Requested by Ehsan · project thread
Before:
docs/held five large pages split out of the old README, while maimanstudio.com/docs had its own, older copy of the documentation (written against 0.8.0, 64 components).After:
docs/has one Markdown file per page of the website's sidebar, under the same categories (Using Maiman Studio, Release news, Development, API reference), anddocs/nav.ymlsays which file is which URL. The site can import these files instead of keeping its own text.index,install,quickstart,studio,graphs,signal-model,sweeps,projects,circuits,server,backends,writing-components) follow the site's pages, updated to the current release:/api/spectrum, lessons and notes, thenotes/annotationsfile keys, the S-matrix tab, the current units list.models.md,validation.md,design.mdandroadmap.mdcarry the detailed content from the earlier README split;releases.mdis the GitHub release notes, 0.1.0 to 0.17.0.docs/components/(all 77 components, one page each) anddocs/api.mdare generated bytools/gen_reference_docs.pyfrom the classes and docstrings.How:
tests/test_docs.pyfails if the generated pages differ from what the script writes, ifnav.ymlnames a missing file, or if any relative link or heading anchor indocs/or the README is broken. Checked on Python 3.11, 3.12 and 3.13. CONTRIBUTING gains the regenerate step.🤖 Generated with Claude Code
https://claude.ai/code/session_015NAUQm8LQftjtRw8cqdSq7
Generated by Claude Code