From a5b3c56bc8c1e4777679db61f018936697875047 Mon Sep 17 00:00:00 2001 From: Bradley Camacho <42678939+bradleycamacho@users.noreply.github.com> Date: Fri, 21 Jul 2023 10:38:04 -0700 Subject: [PATCH] feat(style): add label syntax + style guide structure edits --- .../processes-procedures/create-edit-content.mdx | 2 +- .../understand-edit-docs-site-structure.mdx | 8 +++++++- src/nav/style-guide.yml | 12 ++++++------ 3 files changed, 14 insertions(+), 8 deletions(-) diff --git a/src/content/docs/style-guide/writing-docs/processes-procedures/create-edit-content.mdx b/src/content/docs/style-guide/writing-docs/processes-procedures/create-edit-content.mdx index 3ebfa8c3248..18edf010f63 100644 --- a/src/content/docs/style-guide/writing-docs/processes-procedures/create-edit-content.mdx +++ b/src/content/docs/style-guide/writing-docs/processes-procedures/create-edit-content.mdx @@ -1,5 +1,5 @@ --- -title: Create and edit content +title: Create and edit docs contentType: page template: basicDoc topics: diff --git a/src/content/docs/style-guide/writing-docs/processes-procedures/understand-edit-docs-site-structure.mdx b/src/content/docs/style-guide/writing-docs/processes-procedures/understand-edit-docs-site-structure.mdx index f6eefb9097e..6ee0e574cdd 100644 --- a/src/content/docs/style-guide/writing-docs/processes-procedures/understand-edit-docs-site-structure.mdx +++ b/src/content/docs/style-guide/writing-docs/processes-procedures/understand-edit-docs-site-structure.mdx @@ -1,5 +1,5 @@ --- -title: Understand and edit the docs site structure +title: Frontmatter and page templates redirects: - /docs/style-guide/processes-procedures/include-a-doc-in-multiple-menus - /docs/style-guide/processes-procedures/update-left-navigation-pane @@ -162,6 +162,12 @@ Here are important elements of the nav file: + + `label` + no + Creates a label next to the title. Useful for tutorials. + + `rootNav` diff --git a/src/nav/style-guide.yml b/src/nav/style-guide.yml index c4c355f2524..4585bc255e1 100644 --- a/src/nav/style-guide.yml +++ b/src/nav/style-guide.yml @@ -93,23 +93,21 @@ pages: path: /docs/style-guide/writing-strategies/install-docs-guidance - title: Docs site mechanics pages: - - title: Understand and edit docs structure + - title: Edit the docs site structure and nav path: /docs/style-guide/writing-docs/processes-procedures/understand-edit-docs-site-structure - - title: Use content types and text formats + - title: Frontmatter and page templates path: /docs/style-guide/writing-docs/processes-procedures/use-content-types-text-formats - - title: Create and edit content + - title: Create and edit docs path: /docs/style-guide/writing-docs/processes-procedures/create-edit-content - title: Create release notes path: /docs/style-guide/writing-docs/processes-procedures/create-release-notes - - title: Edit checklist - path: /docs/style-guide/writing-docs/processes-procedures/docs-site-edit-checklist - title: Rename or redirect docs path: /docs/style-guide/writing-docs/processes-procedures/rename-or-redirect-document - title: Delete a document path: /docs/style-guide/writing-docs/processes-procedures/delete-document - title: Update the home page path: /docs/style-guide/writing-docs/processes-procedures/edit-homepage - - title: Create preview content + - title: Using the preview site path: /docs/style-guide/writing-docs/processes-procedures/create-preview-document - title: Tech writer processes pages: @@ -133,6 +131,8 @@ pages: path: /docs/style-guide/writing-docs/writer-workflow/github-history - title: Swiftype internal search path: /docs/style-guide/writing-docs/writer-workflow/swiftype-search + - title: Edit checklist + path: /docs/style-guide/writing-docs/processes-procedures/docs-site-edit-checklist - title: Doc types and templates pages: - title: Agent API guide template