docs: link the BrainPy to BrainX guide and migration notes - #876
Merged
Conversation
The BrainX docs now carry two pages for brainpy users: a concept page on how the packages relate, and migration notes with the module and runtime mappings. Nothing in this repository pointed at them, so brainpy readers never reached them. - README: add the concept page to the header links and both pages to the ecosystem list - docs/index.rst: add a Learn more card next to the brainpy.state APIs card - docs/api.rst: extend the brainpy.state admonition, where a reader hunting for a moved symbol will look - brainpy/state/README.md: add both pages under Documentation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds prominent documentation links guiding BrainPy users to the new BrainX ecosystem, including conceptual explanation and migration notes, by updating top-level README, state README, and Sphinx docs entry points. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
The BrainX docs now carry two pages written for
brainpyusers:brainpyand the BrainX packages relate, which package owns which modeling scale, andwhether a given project should move
the mechanics:
brainpyvsbrainpy.state, runtime and module mapping tables, a workedbefore/after E/I network, and what does not carry over
Nothing in this repository pointed at either, so
brainpyreaders never reached them.This adds links in the four places a reader would plausibly look.
Changes
README.md— the concept page in the header link block; both pages in the ecosystem listdocs/index.rst— a Learn more card, next to the existingbrainpy.stateAPIs carddocs/api.rst— extends thebrainpy.stateadmonition added in docs: link brainpy.state relationship and fix stale doc URLs #873; someone huntingthe API reference for a moved symbol is exactly who needs the mapping tables
brainpy/state/README.md— both pages under DocumentationLinks only — no existing URLs changed.
Verification
sphinx-buildoverdocs/exits 0 with no warning fromindex.rstorapi.rst(the 534 pre-existing warnings are unrelated)
🤖 Generated with Claude Code
Summary by Sourcery
Add documentation cross-links to guide BrainPy users towards the new BrainX overview and migration notes.
Documentation: