Skip to content

fix: remove duplicated summary pages from docs nav - #747

Merged
joamatab merged 1 commit into
gdsfactory:mainfrom
jackgdsf:fix/remove-duplicate-summary-pages
Aug 1, 2026
Merged

fix: remove duplicated summary pages from docs nav#747
joamatab merged 1 commit into
gdsfactory:mainfrom
jackgdsf:fix/remove-duplicate-summary-pages

Conversation

@jackgdsf

@jackgdsf jackgdsf commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Remove thin/empty landing pages (plugins_optimization.md, plugins_process.md, plugins_mode_solver.md, plugins_fdtd.md, plugins_circuits.md) that duplicate the nav section headings — leftovers from the Jupyter Book migration.
  • Also remove plugins_mesh.md and sdl.md which aren't in the nav and contain broken Jupyter Book {tableofcontents} syntax.

Fixes #746

Test plan

  • CI docs build passes
  • Nav no longer shows duplicated summary pages under each section

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

Streamline the documentation by removing obsolete plugin landing pages from the navigation and deleting unused or broken docs files left over from the Jupyter Book migration.

Bug Fixes:

  • Remove duplicate summary pages from the docs navigation so each section only lists its actual content pages.

Enhancements:

  • Clean up obsolete plugin and SDL documentation pages that were thin, unused, or contained broken Jupyter Book syntax.

Build:

  • Update docs nav configuration to reflect removal of obsolete plugin-related pages.

Remove thin/empty landing pages (plugins_optimization.md,
plugins_process.md, plugins_mode_solver.md, plugins_fdtd.md,
plugins_circuits.md) that duplicate the nav section headings.
Also remove plugins_mesh.md and sdl.md which aren't in the nav
and contain broken Jupyter Book {tableofcontents} syntax.

Fixes gdsfactory#746

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 Aug 1, 2026

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

Reviewer's Guide

Removes duplicated and unused documentation landing pages from the docs navigation and deletes their corresponding markdown files to clean up the Jupyter Book migration leftovers.

Flow diagram for cleaned docs navigation structure

flowchart TD
    docs[Docs root]
    design[Design section]
    optimization[Optimization]
    devicesim[Device_Simulators]
    modesolvers[Mode_Solvers]
    fdtd[FDTD]
    circuits[Circuit_Simulators]

    docs --> design
    design --> optimization
    design --> devicesim
    design --> modesolvers
    design --> fdtd
    design --> circuits

    optimization --> ray_optimiser[notebooks/ray_optimiser.md]
    optimization --> pso[notebooks/pso.md]

    devicesim --> femwell_heater[notebooks/femwell_02_heater.md]
    devicesim --> tcad_analytical[notebooks/tcad_02_analytical_process.md]
    devicesim --> tcad_implant[notebooks/tcad_03_numerical_implantation.md]

    modesolvers --> femwell_modes[notebooks/femwell_01_modes.md]
    modesolvers --> fdfd[notebooks/mode_solver_fdfd.md]
    modesolvers --> mpb_waveguide[notebooks/mpb_001_mpb_waveguide.md]

    fdtd --> tidy3d[notebooks/tidy3d_00_tidy3d.md]
    fdtd --> lumerical_fdtd[notebooks/lumerical_1_fdtd_sparameters.md]

    circuits --> sax[notebooks/sax_01_sax.md]
    circuits --> vlsir[notebooks/vlsir_netlist.md]
Loading

File-Level Changes

Change Details Files
Clean up docs navigation by removing thin duplicate section landing pages.
  • Update docs/zensical.yml nav entries to drop the top-level plugin summary pages under Optimization, Device Simulators, Mode Solvers, FDTD, and Circuit Simulators.
  • Ensure remaining nav entries still point directly to the relevant notebooks without orphaned or broken links.
docs/zensical.yml
Delete obsolete markdown summary and plugin pages that either duplicated nav headings or contained broken Jupyter Book syntax.
  • Remove plugin summary markdown files for various simulator categories that no longer need dedicated landing pages.
  • Delete plugins_mesh.md and sdl.md which are unused in the nav and contain invalid {tableofcontents} syntax from Jupyter Book.
docs/plugins_circuits.md
docs/plugins_fdtd.md
docs/plugins_mesh.md
docs/plugins_mode_solver.md
docs/plugins_optimization.md
docs/plugins_process.md
docs/sdl.md

Assessment against linked issues

Issue Objective Addressed Explanation
#746 Remove thin/empty summary pages (plugins_optimization.md, plugins_process.md, plugins_mode_solver.md, plugins_fdtd.md, plugins_circuits.md) from the docs navigation so they no longer appear as redundant first entries under each Design sub-section.
#746 Remove the corresponding summary page files (plugins_optimization.md, plugins_process.md, plugins_mode_solver.md, plugins_fdtd.md, plugins_circuits.md) from the docs so they are no longer present in the repository.
#746 Remove plugins_mesh.md and sdl.md from the docs, as they are not in the nav and contain broken Jupyter Book {tableofcontents} syntax.

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 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 merged commit 25608f5 into gdsfactory:main Aug 1, 2026
16 of 18 checks passed
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.

Remove duplicated summary pages from docs nav

2 participants