Skip to content

docs: link the BrainPy to BrainX guide and migration notes - #876

Merged
chaoming0625 merged 1 commit into
mainfrom
docs/link-brainx-migration
Aug 7, 2026
Merged

docs: link the BrainPy to BrainX guide and migration notes#876
chaoming0625 merged 1 commit into
mainfrom
docs/link-brainx-migration

Conversation

@chaoming0625

@chaoming0625chaoming0625 commented Aug 7, 2026

Copy link
Copy Markdown
Member

The BrainX docs now carry two pages written for brainpy users:

  • BrainPy to BrainX — how
    brainpy and the BrainX packages relate, which package owns which modeling scale, and
    whether a given project should move
  • BrainPy migration notes
    the mechanics: brainpy vs brainpy.state, runtime and module mapping tables, a worked
    before/after E/I network, and what does not carry over

Nothing in this repository pointed at either, so brainpy readers 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 list
  • docs/index.rst — a Learn more card, next to the existing brainpy.state APIs card
  • docs/api.rst — extends the brainpy.state admonition added in docs: link brainpy.state relationship and fix stale doc URLs #873; someone hunting
    the API reference for a moved symbol is exactly who needs the mapping tables
  • brainpy/state/README.md — both pages under Documentation

Links only — no existing URLs changed.

Verification

  • sphinx-build over docs/ exits 0 with no warning from index.rst or api.rst
    (the 534 pre-existing warnings are unrelated)
  • all three linked URLs return 200

🤖 Generated with Claude Code

Summary by Sourcery

Add documentation cross-links to guide BrainPy users towards the new BrainX overview and migration notes.

Documentation:

  • Link the BrainPy-to-BrainX guide and migration notes from the main README ecosystem section and header links.
  • Expose the BrainPy-to-BrainX guide and migration notes from the brainpy.state README documentation links.
  • Add pointers in the Sphinx docs index and API pages to the BrainPy-to-BrainX overview and migration resources for users searching the state-based API.

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
@sourcery-ai

sourcery-aiBot commented Aug 7, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds 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

ChangeDetailsFiles
Expose BrainPy→BrainX conceptual and migration docs from the top-level project README.
  • Add a new header link to the BrainPy-to-BrainX conceptual page alongside existing documentation and ecosystem links.
  • Extend the ecosystem/resources list with a BrainPy-to-BrainX entry that also inlines a link to the migration notes page and briefly describes their purpose.
README.md
Expose BrainPy→BrainX docs from the brainpy.state package README for state-based users.
  • Add links to the BrainPy-to-BrainX conceptual page and the migration notes page under the Documentation section so state-based users can discover cross-ecosystem guidance.
brainpy/state/README.md
Surface migration guidance from Sphinx docs entry points for users browsing HTML docs.
  • Add a new “Learn more” card on the documentation index pointing to the BrainPy-to-BrainX conceptual page, colocated with the existing brainpy.state APIs card.
  • Extend the brainpy.state-related admonition in the API reference to mention and link to the migration notes and/or BrainPy-to-BrainX docs for users searching for moved symbols.
docs/index.rst
docs/api.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actionsgithub-actionsBot added the documentation Improvements or additions to documentation label Aug 7, 2026

@sourcery-aisourcery-aiBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov

codecovBot commented Aug 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@chaoming0625
chaoming0625 merged commit 52e01d6 into mainAug 7, 2026
15 checks passed
@chaoming0625
chaoming0625 deleted the docs/link-brainx-migration branch August 7, 2026 02:40
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@chaoming0625