Skip to content

Fix broken documentation URLs - #741

Merged
joamatab merged 2 commits into
gdsfactory:mainfrom
jackgdsf:fix-broken-links
Jul 25, 2026
Merged

Fix broken documentation URLs#741
joamatab merged 2 commits into
gdsfactory:mainfrom
jackgdsf:fix-broken-links

Conversation

@jackgdsf

@jackgdsf jackgdsf commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Closes #740

  • Fix meep readthedocs URL: GDSII_ImportGDS_Import (page renamed upstream)
  • Fix Palace docs URLs: config/solver/config/reference/ (docs restructured)
  • Fix Jupyter Book URLs: add /en/stable/ prefix (docs moved)
  • Update gdsfactory docs comment URLs to current paths

Test plan

  • Pre-commit lychee link check passes
  • No functional code changes — only URLs in comments and docstrings

Reminder: AI-created PRs still require human review of the actual code changes before merge. I'll open the PR, but a human must review and approve it.

🤖 Generated with Claude Code

Summary by Sourcery

Update documentation references to point to current external URLs without changing runtime behavior.

Documentation:

  • Refresh Jupyter Book configuration and TOC comments to use the stable jupyterbook.org URLs.
  • Correct Meep manual links in simulation utilities and example notebook to the renamed GDS import page.
  • Update Palace documentation links in Palace-related plugins to the restructured config reference section.
  • Adjust gdsfactory documentation comment URLs to match current notebook and API paths.

- meep: GDSII_Import → GDS_Import (page renamed upstream)
- palace: config/solver/ → config/reference/ (docs restructured)
- jupyterbook.org: add /en/stable/ prefix (docs moved)
- gdsfactory docs: update to current paths

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@sourcery-ai

sourcery-ai Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

🧙 Sourcery has finished reviewing your pull request!


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

@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 left some high level feedback:

  • For the Palace documentation links, consider updating to more specific anchors within config/reference (e.g., pointing directly to the Solver/Linear/Driven sections) to preserve the original level of guidance for users.
  • Double-check whether using the /en/stable/ prefix for all Jupyter Book references is desired long-term, as hardcoding the versioned path may require future updates when the default stable version changes.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- For the Palace documentation links, consider updating to more specific anchors within `config/reference` (e.g., pointing directly to the `Solver`/`Linear`/`Driven` sections) to preserve the original level of guidance for users.
- Double-check whether using the `/en/stable/` prefix for all Jupyter Book references is desired long-term, as hardcoding the versioned path may require future updates when the default stable version changes.

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.

…d _toc.yml

These files were removed upstream as part of the docs migration.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@joamatab
joamatab merged commit f73f9f2 into gdsfactory:main Jul 25, 2026
13 of 15 checks passed
@estanton22 estanton22 mentioned this pull request Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix broken documentation URLs

2 participants