-
Notifications
You must be signed in to change notification settings - Fork 64
Improving API docs #2761
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
yuanshen-flexcompute
wants to merge
30
commits into
develop
Choose a base branch
from
demo/test/docs_api
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Improving API docs #2761
Conversation
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
draft work in progress
Completed first draft of "EM Mediums" page
Fix some typos
Changes as per Tom's suggestions
WIP draft of the geometry page
First draft commit
Started draft of Boundary Conditions page
draft work in progress
Completed first draft of "EM Mediums" page
Fix some typos
Changes as per Tom's suggestions
WIP draft of the geometry page
First draft commit
Started draft of Boundary Conditions page
…idy3d into demo/test/docs_api
First draft of Boundary Conditions
see title
also removed Subpixel Averaging and Field Projector pages since they are discussed in the other pages
Thanks greptile
…idy3d into demo/test/docs_api
Thanks greptile
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
17 files reviewed, 9 comments
Thanks greptile
Diff CoverageDiff: origin/develop...HEAD, staged and unstaged changesNo lines with coverage information in this diff. |
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.
Adding summary pages for each major section in the API docs. Also did some re-arrangement for better readability and user access.
Greptile Summary
This PR represents a comprehensive overhaul of the Tidy3D API documentation structure, transforming it from basic auto-generated reference pages into user-friendly, educational guides. The changes add detailed overview sections, practical code examples, and logical reorganization across multiple documentation files.
Key improvements include:
sources.rst
,mediums.rst
,monitors.rst
, andgeometry.rst
now include comprehensive overview sections that explain concepts before diving into API detailsThe restructuring follows modern documentation best practices by emphasizing user experience and progressive disclosure over pure API enumeration. Files are organized to match typical user workflows, starting with basic concepts and progressing to advanced features. The changes maintain all original API references while significantly enhancing discoverability and educational value.
Important Files Changed
File Changes Summary
docs/api/abstract_models.rst
docs/api/subpixel_averaging.rst
docs/api/monitors.rst
docs/api/abstract_base.rst
docs/api/geometry.rst
docs/api/boundary_conditions.rst
docs/api/discretization.rst
docs/api/field_projector.rst
docs/api/index.rst
docs/api/mediums.rst
docs/api/output_data.rst
docs/api/scene.rst
docs/api/simulation.rst
docs/api/sources.rst
docs/api/structure_and_scene.rst
docs/api/structures.rst
docs/api/submit_simulations.rst
Confidence score: 2/5
abstract_models.rst
(extensive duplicates),monitors.rst
(syntax error), andsubpixel_averaging.rst
(empty file)