API Quick-Start Guides within subsections

[daquinteroflex]

(Thanks to a bit of chatgpt help)
We want API documentation articles that provide a clear, narrative overview of each specific subsection of the Tidy3D documentation.

These are currently lists, we want users to understand how they fit in the bigger picture:

• https://docs.flexcompute.com/projects/tidy3d/en/latest/api/index.html
• https://docs.flexcompute.com/projects/tidy3d/en/latest/api/sources.html
• https://docs.flexcompute.com/projects/tidy3d/en/latest/api/mediums.html
• etc.

This guide should help users—especially those transitioning to use the Python interface — to quickly understand key concepts, workflows, and code examples. One target area is the simulation data structure and post-processing, this task applies to any subsection that would benefit from a more narrative, beginner-friendly explanation.

To implement this you'll need to write reStructuredText format that interfaces with multiple toctrees in our documentation and include a dedicated section with placeholders for examples. Additionally, the documentation must be built and verified using Sphinx to ensure proper integration and rendering. See the development instructions here https://docs.flexcompute.com/projects/tidy3d/en/latest/development/index.html

The subsection articles can explain:

• The core concepts of the selected subsection (e.g., simulation data structure, source definitions, or post-processing workflows).
• How the different components or classes in this area integrate and work together.
• A concise, step-by-step workflow covering:
  • Loading or initializing the relevant objects.
  • Accessing and manipulating key data or configurations.
  • Visualizing or exporting results, if applicable.
• Include dedicated sections for:
  • Overview: An explanation of the core concepts.
  • Workflow: Step-by-step instructions with code snippets.
  • Examples: A placeholder section where additional examples can be added later (please leave comments or space for future examples).
• Use a narrative, beginner-friendly style with clear, sequential instructions.
• Include updated, working code snippets with comments that illustrate the concepts.
• Remove any expired or irrelevant links from previous documentation.
• Ensure the guide helps bridge the gap between GUI usage and Python scripting.
• Follow our internal documentation style and formatting guidelines.

Make sure to verify all the code is valid, and we'll be testing the examples code with pytest. Use the examples to understand how everything fits together. We'll do a thorough review on the docs version you produce too.

[daquinteroflex]

Fyi @tomflexcompute too