Skip to content

Commit 17e845f

Browse files
docs: minor notes about syncs and releases (#409)
1 parent 915944d commit 17e845f

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ You can see our [pretty example library documentation](https://docs.flexcompute.
66

77
- Make sure all your internal API references start with ``tidy3d.<your_reference>``
88
- In notebooks, always have absolute links, otherwise the links will break when the user downloads them.
9+
- The `develop` branch is syced to the state of the webcenter in order to enable new notebooks to be featured quickly.
10+
- 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.
11+
12+
These instructions are valid as of Nov 2025, but may change depending on structural planned changes and you can verify with the team.
13+
914

1015
## Common Documentation References
1116

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

0 commit comments

Comments
 (0)