Add documentation for DocumentBar (#61733)

Co-authored-by: nateinaction <[email protected]> Co-authored-by: colorful-tones <[email protected]>
WordPress · May 21, 2024 · 9acffd0 · 9acffd0 · github-actions · May 21, 2024
1 parent c706195
commit 9acffd0
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/packages/editor/README.md b/packages/editor/README.md
@@ -254,7 +254,17 @@ _Returns_
 
 ### DocumentBar
 
-Undocumented declaration.
+This component renders a navigation bar at the top of the editor. It displays the title of the current document, a back button (if applicable), and a command center button. It also handles different states of the document, such as "not found" or "unsynced".
+
+_Usage_
+
+```jsx
+<DocumentBar />
+```
+
+_Returns_
+
+-   `JSX.Element`: The rendered DocumentBar component.
 
 ### DocumentOutline
 

diff --git a/packages/editor/src/components/document-bar/index.js b/packages/editor/src/components/document-bar/index.js
@@ -49,6 +49,18 @@ const GLOBAL_POST_TYPES = [
 
 const MotionButton = motion( Button );
 
+/**
+ * This component renders a navigation bar at the top of the editor. It displays the title of the current document,
+ * a back button (if applicable), and a command center button. It also handles different states of the document,
+ * such as "not found" or "unsynced".
+ *
+ * @example
+ * ```jsx
+ * <DocumentBar />
+ * ```
+ *
+ * @return {JSX.Element} The rendered DocumentBar component.
+ */
 export default function DocumentBar() {
 	const {
 		postType,