Add interactive layer stack diagram to docs - #320
Open
jackgdsf wants to merge 1 commit into
Open
Conversation
Add .github/write_layer_stack.py that generates docs/layer_stack.md with interactive SVG/JS visualizations of the layer stack and cross-sections for each platform (Si220 C/O-band, Si500, SiN300, Si340, SiN200, Ge-on-Si, Si Suspended). Features: Uniform/To Scale toggle, cross-section profiles, tooltips, pan+zoom. Runs during `make docs`. Closes gdsfactory#319 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
jackgdsf
requested review from
MarkCunningham0410,
cdaunt,
joamatab and
thanojo
as code owners
July 28, 2026 15:56
Contributor
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
Reviewer's GuideAdds an auto-generated docs/layer_stack.md page with interactive SVG/JS layer stack and cross-section visualizations for multiple PDK bands, integrates its generation into all docs Makefile targets, and exposes it under the Reference section in the docs navigation. File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The CSS block
CSSis appended inside every band section, which duplicates style tags in the generated markdown; consider emitting the<style>once at the top of the page or moving it to a shared docs stylesheet and referencing it to keep the output leaner and easier to maintain. - The output path is derived from
PATH.repoimported fromcspdk.si220.cband.config, which couples this script to a specific PDK; using something likePath(__file__).resolve().parents[1] / "docs" / "layer_stack.md"(or a similar repo-root discovery) would make the script more robust if Si220 paths or configs change.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The CSS block `CSS` is appended inside every band section, which duplicates style tags in the generated markdown; consider emitting the `<style>` once at the top of the page or moving it to a shared docs stylesheet and referencing it to keep the output leaner and easier to maintain.
- The output path is derived from `PATH.repo` imported from `cspdk.si220.cband.config`, which couples this script to a specific PDK; using something like `Path(__file__).resolve().parents[1] / "docs" / "layer_stack.md"` (or a similar repo-root discovery) would make the script more robust if Si220 paths or configs change.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
Summary
.github/write_layer_stack.pythat generatesdocs/layer_stack.mdwith interactive SVG/JS visualizationsmake docs/make docs-serve/make docs-pdfdocs/zensical.tomlunder ReferenceCloses #319
Reminder
Test plan
make docslocally and verifydocs/layer_stack.mdis generated🤖 Generated with Claude Code
Summary by Sourcery
Generate an interactive layer stack documentation page for all available PDK platforms and integrate it into the docs build and navigation.
New Features:
Enhancements: