Skip to content

fix: replace dead SAX docs link in sax_01_sax notebook#726

Merged
joamatab merged 3 commits into
gdsfactory:mainfrom
jackgdsf:fix/sax-docs-link
Jun 7, 2026
Merged

fix: replace dead SAX docs link in sax_01_sax notebook#726
joamatab merged 3 commits into
gdsfactory:mainfrom
jackgdsf:fix/sax-docs-link

Conversation

@jackgdsf

@jackgdsf jackgdsf commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Summary by Sourcery

Documentation:

  • Update the SAX circuit simulator notebook to use the new sax.readthedocs.io documentation URL.

The old flaport.github.io/sax/ returns 404, causing the lychee
link-checker pre-commit hook to fail.
@sourcery-ai

sourcery-ai Bot commented Jun 7, 2026

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

Reviewer's Guide

Updates a broken SAX documentation link in the sax_01_sax tutorial notebook to the current ReadTheDocs URL so link checking passes again.

File-Level Changes

Change Details Files
Update SAX documentation hyperlink in the sax_01_sax Jupyter notebook to a non-broken URL.
  • Replace the old SAX docs URL that returns 404 with the new ReadTheDocs URL.
  • Ensure the notebook text still correctly describes SAX while only changing the hyperlink target.
notebooks/sax_01_sax.ipynb

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

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request updates the SAX documentation URL in the notebooks/sax_01_sax.ipynb notebook to point to the official Read the Docs site. Since there are no review comments, I have no feedback to provide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

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.

@joamatab joamatab left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

fix links

@joamatab joamatab added the documentation Improvements or additions to documentation label Jun 7, 2026
@joamatab joamatab merged commit c94993a into gdsfactory:main Jun 7, 2026
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants