From a8bd77fd3a13f92ff7b620109c7e1277bcf23c93 Mon Sep 17 00:00:00 2001 From: daquinteroflex Date: Thu, 20 Nov 2025 18:44:16 +0100 Subject: [PATCH] docs: minor notes about syncs and releases --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f85f2a8d..1019945b 100644 --- a/README.md +++ b/README.md @@ -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.`` - 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 @@ -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 | \ No newline at end of file +| FAQ Source Code | https://github.com/flexcompute/tidy3d-faq |