Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ You can see our [pretty example library documentation](https://docs.flexcompute.

- Make sure all your internal API references start with ``tidy3d.<your_reference>``
- In notebooks, always have absolute links, otherwise the links will break when the user downloads them.
- The `develop` branch is syced to the state of the webcenter in order to enable new notebooks to be featured quickly.
- If you are developing a notebook using a version that is not the latest official version (i.e. 2.9.1 vs the python client `develop` branch) make sure to merge it only after the python client has been released. Or use a `pre/2.10` branch.

These instructions are valid as of Nov 2025, but may change depending on structural planned changes and you can verify with the team.


## Common Documentation References

Expand All @@ -23,4 +28,4 @@ You can see our [pretty example library documentation](https://docs.flexcompute.
|--------------------|-------------------------------------------------|
| Source Code | https://github.com/flexcompute/tidy3d |
| Example Notebooks | https://github.com/flexcompute/tidy3d-notebooks |
| FAQ Source Code | https://github.com/flexcompute/tidy3d-faq |
| FAQ Source Code | https://github.com/flexcompute/tidy3d-faq |