docs(all): standardize docs (#17631)

remoteId: rem_01jwbtfqhbbam07z9j9m0etng6
remoteUpdateId: grupd_01k3h87wcmh61rtdrvfpesq9d9
branchName: main
commitSha: dbbc4a78be30d184e642240a80fd9de6a6c25669
commitUrl: Redocly/redocly@dbbc4a7

Author: adamaltman

docs/realm/.templates/reference.md

@@ -42,12 +42,6 @@ Include explanatory information describing the result of the configuration.-->
 
 ## Examples
 
-<!--Related options
--------------------
-
-Include a bulleted list of related reference documentation links.-->
-
-## Related options
 
 <!--Resources
 -------------

docs/realm/config/apis.md

@@ -59,8 +59,10 @@ If your project contains multiple APIs, you can use the `apis` configuration sec
 ---
 
 - output
-- Output file path
-- When running `bundle` without specifying an API, the bundled API description is saved to this location.
+- string
+- Output file path.
+  When running `bundle` without specifying an API, the bundled API description is saved to this location.
+  Example: `docs/api.yaml`.
 
 {% /table %}
 

docs/realm/config/asyncapi.md

@@ -30,38 +30,38 @@ Requires an AsyncAPI definition.
 ---
 
 - schemaId
-- String
+- string
 - Schema ID.
   Defaults to `asyncapi`.
 
 ---
 
 - hideInfo
-- Boolean
+- boolean
 - Set to `true` to hide info section including API title.
 
 ---
 
 - hideOperations
-- Boolean
+- boolean
 - Set to `true` to hide Operations section
 
 ---
 
 - hideServers
-- Boolean
+- boolean
 - Set to `true` to hide Servers section
 
 ---
 
 - hideMessages
-- Boolean
+- boolean
 - Set to `true` to hide Messages section
 
 ---
 
 - hideSchemas
-- Boolean
+- boolean
 - Set to `true` to hide Schemas section
 
 {% /table %}

docs/realm/config/breadcrumbs.md

@@ -83,14 +83,11 @@ breadcrumbs:
       labelTranslationKey: home.title
 ```
 
-## Related options
-
-- Customize other default items on Markdown pages, such as the last updated time stamp and the page headings table of contents on the left side of the page, using the [`markdown` configuration options](markdown.md).
-- Remove or update the label text for the previous and next navigation buttons using the [`navigation` configuration options](navigation.md).
-
 ## Resources
 
 - **[Navigation concepts](../navigation/navigation.md)** - Understand different navigation elements in your project including breadcrumbs and their role in user experience
 - **[Configure navigation elements](../navigation/index.md)** - Customize navigation elements including sidebar, navbar, footer, and breadcrumbs for optimal site organization
 - **[Front matter configuration](./front-matter-config.md)** - Configure breadcrumb behavior and appearance on individual pages using front matter for granular control
 - **[Configuration options](./index.md)** - Explore other project configuration options for comprehensive documentation and platform customization
+- **[Markdown configuration options](markdown.md)** - Customize default items on Markdown pages including time stamps and table of contents for enhanced breadcrumb integration
+- **[Navigation configuration options](navigation.md)** - Configure previous and next navigation buttons and label text for seamless breadcrumb navigation flow

docs/realm/config/catalog-classic.md

@@ -25,7 +25,7 @@ You can configure multiple catalogs and set the link text, description, and filt
 ---
 
 - catalogClassic
-- Map of strings to [Catalog Classic](#catalog-classic-object)
+- Map[string, [Catalog Classic](#catalog-classic-object)]
 - **REQUIRED.**
   Map of strings allows for the definition of multiple catalogs.
   Strings represent catalog only in configuration file - they do not appear in published project.
@@ -218,8 +218,9 @@ You can configure multiple catalogs and set the link text, description, and filt
 ---
 
 - includeByMetadata
-- Map of metadata properties to list of string values
-- Restricts what to include in the catalog.
+- Map[string, [string]]
+- Map of metadata properties to list of string values.
+  Restricts what to include in the catalog.
   Example: `{"type": ["openapi"]}`.
 
 {% /table %}

docs/realm/config/developer-onboarding/index.md

@@ -291,10 +291,7 @@ developerOnboarding:
       apiBaseUrl: https://apim-dev.acme-inc.com
 ```
 
-## Related options
-
-- [sso](../sso.md)
-
 ## Resources
 
 - **[List of used Apigee API endpoints](./apigee-api-operations.md)** - Complete reference of Apigee API endpoints used by the developer onboarding feature for integration and troubleshooting
+- **[SSO configuration](../sso.md)** - Configure single sign-on authentication required for developer onboarding and app registration workflows

docs/realm/config/env.md

@@ -26,23 +26,23 @@ configuration file in the **root** directory and referencing it in the `env` opt
 ---
 
 - preview
-- [[Redocly config](./index.md) or [Reference object](#reference-object)]
+- [[Redocly config](./index.md) | [Reference object](#reference-object)]
 - Configuration for the preview environment.
 
 ---
 
 ---
 
 - development
-- [[Redocly config](./index.md) or [Reference object](#reference-object)]
+- [[Redocly config](./index.md) | [Reference object](#reference-object)]
 - Configuration for the development environment.
 
 ---
 
 ---
 
 - production
-- [[Redocly config](./index.md) or [Reference object](#reference-object)]
+- [[Redocly config](./index.md) | [Reference object](#reference-object)]
 - Configuration for the production environment.
 
 ---

docs/realm/config/front-matter-config.md

@@ -40,7 +40,7 @@ These options are available exclusively in front matter:
 ---
 
 - slug
-- string or [string]
+- string | [string]
 - Custom URL path for this page, instead of the default path based on folder and file names.
   Define multiple slugs to make content available at multiple URLs.
   Slugs can contain multiple segments (e.g., '/custom-pages/page-1').
@@ -125,9 +125,9 @@ When defined in front matter, they override the global configuration:
 ---
 
 - rbac
-- [team to role map](./rbac.md#team-to-role-map)
-- Set access permissions for the page.
-  This option can contain only the map of teams to roles.
+- [Map[string, string]](./rbac.md#team-to-role-map)
+- Map of teams to roles.
+  Set access permissions for the page.
 
 ---
 

docs/realm/config/graphql/field-expand-level.md

@@ -42,12 +42,8 @@ graphql:
 
 If you have fields with more than three levels of data structure within them, users will need to visit the data types documentation for that type rather than having it all displayed in the "Return type" section.
 
-## Related options
-
-- [jsonSamplesDepth](./json-samples-depth.md) - Sets the default expand level for JSON payload samples.
-- [graphql](./index.md) - Learn more about using `graphql` configuration.
-
 ## Resources
 
 - **[GraphQL](https://graphql.org/)** - Official GraphQL specification and documentation for understanding query language fundamentals
 - **[GraphQL configuration](./index.md)** - Complete guide to GraphQL configuration options for customizing API reference documentation
+- **[JSON samples depth](./json-samples-depth.md)** - Set the default expand level for JSON payload samples to work alongside field expand level settings

docs/realm/config/graphql/json-samples-depth.md

@@ -40,13 +40,9 @@ graphql:
 
 Using this setting, the samples will show up to five levels of nested payload data.
 
-## Related options
-
-- [samplesMaxInlineArgs](./samples-max-inline-args.md) - Maximum number of inline arguments for samples.
-- [fieldExpandLevel](./field-expand-level.md) - Maximum depth of the `Return type` in the middle panel.
-- [graphql](./index.md) - Learn more about using the `graphql` configuration.
-
 ## Resources
 
 - **[GraphQL](https://graphql.org/)** - Official GraphQL specification and documentation for understanding query language fundamentals
-- **[GraphQL configuration](./index.md)** - Complete guide to GraphQL configuration options for customizing API reference documentation
+- **[GraphQL configuration](./index.md)** - Complete guide to GraphQL configuration options for customizing API reference documentation
+- **[Samples max inline arguments](./samples-max-inline-args.md)** - Configure the maximum number of inline arguments for samples to complement JSON payload depth settings
+- **[Field expand level](./field-expand-level.md)** - Set the maximum depth of the Return type in the middle panel for comprehensive data structure display