Update docs for 0.4.0

README.md

@@ -6,7 +6,8 @@ You can find further documentation [here](https://github.com/netboxlabs/netbox-c
 
 ## Requirements
 
-* NetBox v4.4 or later
+* NetBox v4.4.0 or later
+* (Optional) NetBox Branching 0.7.1 or later
 
 ## Installation
 
@@ -36,6 +37,20 @@ $ ./manage.py migrate
 sudo systemctl restart netbox netbox-rq
 ```
 
+> [!NOTE]
+> If you are using NetBox Custom Objects with NetBox Branching, you need to insert the following into your `configuration.py`. See the docs for a full description of how NetBox Custom Objects currently works with NetBox Branching.  
+
+```
+PLUGINS_CONFIG = {
+    'netbox_branching': {
+        'exempt_models': [
+            'netbox_custom_objects.customobjecttype',
+            'netbox_custom_objects.customobjecttypefield',
+        ],
+    },
+}
+```
+
 ## Known Limitations
 
-NetBox Custom Objects is under active development and some features may not be complete as designed. The best place to look for the latest list of known limitations is the [issues](https://github.com/netboxlabs/netbox-custom-objects/issues) list on the GitHub repository.
+NetBox Custom Objects is now Generally Available which means you can use it in production and migrations to future versions will work. There are many upcoming features including GraphQL support - the best place to see what's on the way is the [issues](https://github.com/netboxlabs/netbox-custom-objects/issues) list on the GitHub repository.

docs/branching.md

@@ -0,0 +1,24 @@
+# Using NetBox Custom Objects with NetBox Branching
+
+As of version 0.4.0 Custom Objects is _compatible_ with NetBox Branching, but not fully supported. This means that users can safely use both plugins together, but there are some caveats to be aware of. See below to learn how each of the Custom Objects models interacts with NetBox Branching.
+
+> [!NOTE]
+> We are working towards full support for Custom Objects on branches. Keep an eye on the GitHub issues for updates ahead of future releases.  
+
+> [!TIP]
+> If you have any questions the best place to start is on the GitHub [discussions](https://github.com/netboxlabs/netbox-custom-objects/discussions). If you are a NetBox Labs customer, you can also contact support.  
+
+## Custom Object Types and Custom Object Type Fields
+
+Custom Object Types and Custom Object Type fields can be created, updated and deleted on branches, however the changes made on branches will be applied in main. This allows Custom Objects and Branching to be used safely alongside each other, but users should be aware of what this means.
+
+- When you are in an activated branch any creates, updates and deletes you perform on Custom Object Types and Custom Object Type Fields will not show up in the Diff or Changes Ahead views
+- Although you're in an activated branch, these changes will be made directly to main
+- Typically it will be NetBox admins who are altering Custom Object Types and Custom Object Type Fields - we recommend that you experiment in your staging instance until you are satisfied with the modelling and then move them into prod
+
+## Custom Objects
+
+Changes to Custom Objects on branches are disallowed.
+
+- When in an activated branch, users will still be able to see the available Custom Object Types and any Custom Objects that were brought into the branch upon branch creation, but will not be able to interact with them to affect changes on the branch.  
+- This approach was chosen to make sure that users can safely use both Custom Objects and Branching together, while we are working on fuller support.  

docs/index.md

@@ -2,10 +2,16 @@
 
 [NetBox](https://github.com/netbox-community/netbox) is the world's leading source of truth for infrastructure, featuring an extensive data model. Sometimes it can be useful to extend the NetBox data model to fit specific organizational needs. The Custom Objects plugin introduces a new paradigm for NetBox to help overcome these challenges, allowing NetBox adminstrators to extend the NetBox data model without writing a line of code.
 
-For additional documentation on the REST API, go [here](api.md).
+- For additional documentation on the REST API, go [here](api.md).
+- For information about using Custom Objects with NetBox Branching, go [here](branching.md)
 
 > [!TIP]
-> NetBox Custom Objects is still in Public Preview. If you hit any problems please check the [exiting issues](https://github.com/netboxlabs/netbox-custom-objects/issues) before creating a new one. If you're unsure, start a [discussion](https://github.com/netboxlabs/netbox-custom-objects/discussions).
+> If you hit any problems please check the [existing issues](https://github.com/netboxlabs/netbox-custom-objects/issues) before creating a new one. If you're unsure, start a [discussion](https://github.com/netboxlabs/netbox-custom-objects/discussions).
+
+
+> [!TIP]
+> If you are using Custom Objects with Custom Scripts or Plugins you need to use Django's `AppConfig.get_model` to retrieve Custom Object Types: [https://docs.djangoproject.com/en/5.2/ref/applications/#django.apps.AppConfig.get_model](https://docs.djangoproject.com/en/5.2/ref/applications/#django.apps.AppConfig.get_model)  
+> Pass in the plugin name (`netbox_custom_objects`) and the name of the Custom Object (e.g. `dhcp_scope`) to return the correct object.  
 
 ## Features