From c9f513ce03fccf9f3ee558424638f4e080992413 Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Thu, 29 Jun 2023 09:28:13 -0400
Subject: [PATCH] Add docs for bookmarks

---
 docs/features/customization.md |  4 ++++
 docs/models/extras/bookmark.md | 13 +++++++++++++
 mkdocs.yml                     |  1 +
 3 files changed, 18 insertions(+)
 create mode 100644 docs/models/extras/bookmark.md

diff --git a/docs/features/customization.md b/docs/features/customization.md
index abce4bcba..1fbace3c5 100644
--- a/docs/features/customization.md
+++ b/docs/features/customization.md
@@ -18,6 +18,10 @@ The `tag` filter can be specified multiple times to match only objects which hav
 GET /api/dcim/devices/?tag=monitored&tag=deprecated
 ```
 
+## Bookmarks
+
+Users can bookmark their most commonly visited objects for convenient access. Bookmarks are listed under a user's profile, and can be displayed with custom filtering and ordering on the user's personal dashboard.
+
 ## Custom Fields
 
 While NetBox provides a rather extensive data model out of the box, the need may arise to store certain additional data associated with NetBox objects. For example, you might need to record the invoice ID alongside an installed device, or record an approving authority when creating a new IP prefix. NetBox administrators can create custom fields on built-in objects to meet these needs.
diff --git a/docs/models/extras/bookmark.md b/docs/models/extras/bookmark.md
new file mode 100644
index 000000000..1fd006be9
--- /dev/null
+++ b/docs/models/extras/bookmark.md
@@ -0,0 +1,13 @@
+# Bookmarks
+
+A user can bookmark individual objects for convenient access. Bookmarks are listed under a user's profile and can be displayed using a dashboard widget.
+
+## Fields
+
+### User
+
+The user to whom the bookmark belongs.
+
+### Object
+
+The bookmarked object.
diff --git a/mkdocs.yml b/mkdocs.yml
index 6be33d592..cde4a0acd 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -206,6 +206,7 @@ nav:
             - VirtualChassis: 'models/dcim/virtualchassis.md'
             - VirtualDeviceContext: 'models/dcim/virtualdevicecontext.md'
         - Extras:
+            - Bookmark: 'models/extras/bookmark.md'
             - Branch: 'models/extras/branch.md'
             - ConfigContext: 'models/extras/configcontext.md'
             - ConfigTemplate: 'models/extras/configtemplate.md'