FusionAuth · mooreds · Nov 13, 2024 · Nov 8, 2024 · Nov 8, 2024 · Nov 8, 2024
@@ -58,7 +58,7 @@ const docsCollection = defineCollection({
     quatercategory: z.string().optional(),
     nestedHeadings: z.boolean().optional(),
     disableTOC: z.boolean().default(false),
-    topOfNav: z.boolean().default(false),
+    navOrder: z.number().default(1000),
     idpDisplayName: z.string().optional(),
   }),
 });

@@ -2,7 +2,7 @@
 title: API Authentication
 description: Learn how the FusionAuth APIs authenticate requests.
 section: apis
-topOfNav: true
+navOrder: 0
 ---
 import APIAuthenticationIcon from "src/components/api/APIAuthenticationIcon.astro";
 import APIBlock from 'src/components/api/APIBlock.astro';

@@ -3,7 +3,7 @@ title: Overview
 description: Learn about the APIs for creating, retrieving, updating and deleting identity providers.
 section: apis
 subcategory: connectors
-topOfNav: true
+navOrder: 0
 ---
 import PremiumPlanBlurb from 'src/content/docs/_shared/_premium-plan-blurb.astro';
 import API from 'src/components/api/API.astro';

@@ -3,7 +3,7 @@ title: Overview
 description: Learn about the APIs for creating, retrieving, updating and deleting entities and entity types.
 section: apis
 subcategory: entities
-topOfNav: true
+navOrder: 0
 ---
 import PremiumPlanBlurb from 'src/content/docs/_shared/_premium-plan-blurb.astro';
 

@@ -3,7 +3,7 @@ title: Overview
 description: Learn about the APIs for creating, retrieving, updating and deleting identity providers.
 section: apis
 subcategory: identity providers
-topOfNav: true
+navOrder: 0
 ---
 import API from 'src/components/api/API.astro';
 import StandardGetResponseCodes from 'src/content/docs/apis/_standard-get-response-codes.astro';

@@ -3,7 +3,7 @@ title: Overview
 description: Learn about the APIs for creating, retrieving, updating and deleting messengers.
 section: apis
 subcategory: messengers
-topOfNav: true
+navOrder: 0
 ---
 import API from 'src/components/api/API.astro';
 import APIBlock from 'src/components/api/APIBlock.astro';

@@ -3,7 +3,7 @@ title: Overview
 description: Learn about the APIs for provisioning SCIM Resources in FusionAuth using a SCIM Client.
 section: apis
 subcategory: scim
-topOfNav: true
+navOrder: 0
 ---
 import EnterprisePlanBlurb from 'src/content/docs/_shared/_enterprise-plan-blurb.astro';
 import Aside from 'src/components/Aside.astro';

@@ -4,7 +4,7 @@ description: Learn how to complete a Two Factor authentication for a User.
 section: customize
 subcategory: email and messages
 tertcategory: deprecated
-topOfNav: true
+navOrder: 0
 ---
 import InlineField from 'src/components/InlineField.astro';
 import Aside from 'src/components/Aside.astro';

@@ -3,7 +3,7 @@ title: Email & Messages Overview
 description: An overview of the FusionAuth Email Template system.
 section: customize
 subcategory: email and messages
-topOfNav: true
+navOrder: 0
 ---
 import InlineField from 'src/components/InlineField.astro';
 import EmailTroubleshooting from 'src/content/docs/customize/email-and-messages/_email-troubleshooting.mdx';

@@ -3,7 +3,7 @@ title: Themes Overview
 description: Learn about theming the FusionAuth hosted login pages.
 section: customize
 subcategory: look and feel
-topOfNav: true
+navOrder: 0
 tags: auth as a service
 ---
 import ListHostedLoginPagesUseCases from 'src/content/docs/_shared/_list-hosted-login-pages-use-cases.mdx';

@@ -4,7 +4,7 @@ description: An overview of FusionAuth's lambdas, which are pluggable JavaScript
 section: extend
 subcategory: code
 tertcategory: lambdas
-topOfNav: true
+navOrder: 0
 ---
 import AdvancedPlanBlurb from 'src/content/docs/_shared/_advanced-plan-blurb.astro';
 import Aside from 'src/components/Aside.astro';

@@ -4,7 +4,7 @@ description: An overview of how to make API calls from Lambdas.
 section: extend
 subcategory: code
 tertcategory: lambdas
-topOfNav: true
+navOrder: 10
 ---
 import AdvancedPlanBlurb from 'src/content/docs/_shared/_advanced-plan-blurb.astro';
 import APIBlock from 'src/components/api/APIBlock.astro';

@@ -4,7 +4,7 @@ description: A guide on how to create and test lambdas with FusionAuth.
 section: extend
 subcategory: code
 tertcategory: lambdas
-topOfNav: true
+navOrder: 20
 ---
 import { RemoteCode } from '@fusionauth/astro-components';
 import Aside from 'src/components/Aside.astro';

@@ -4,7 +4,7 @@ description: Extend the functionality of FusionAuth with plugins.
 section: extend
 subcategory: code
 tertcategory: password hashes
-topOfNav: true
+navOrder: 0
 ---
 import InlineField from 'src/components/InlineField.astro';
 import InlineUIElement from 'src/components/InlineUIElement.astro';

@@ -5,7 +5,7 @@ navcategory: developer
 section: extend
 subcategory: events and webhooks
 tertcategory: events
-topOfNav: true
+navOrder: 0
 ---
 import PremiumPlanBlurb from 'src/content/docs/_shared/_premium-plan-blurb.astro';
 import EnterprisePlanBlurb from 'src/content/docs/_shared/_enterprise-plan-blurb.astro';

@@ -4,7 +4,7 @@ description: An overview of the FusionAuth Event and Webhook system.
 navcategory: developer
 section: extend
 subcategory: events and webhooks
-topOfNav: true
+navOrder: 0
 ---
 import APIBlock from 'src/components/api/APIBlock.astro';
 import APIDeprecatedRemoved from 'src/content/docs/_shared/_api-deprecated-removed.mdx';

@@ -5,7 +5,7 @@ navcategory: developer
 section: extend
 subcategory: examples
 tertcategory: api gateways
-topOfNav: true
+navOrder: 0
 ---
 import ApiGatewayArchitectureDiagram from 'src/diagrams/docs/extend/examples/api-gateways/_example-api-gateway-architecture.astro';
 import InlineField from 'src/components/InlineField.astro';

@@ -4,7 +4,7 @@ description: Learn how to install FusionAuth using cloud marketplaces such as AW
 section: get started
 subcategory: run in the cloud
 tertcategory: marketplaces
-topOfNav: true
+navOrder: 0
 ---
 import PaidFeatures from 'src/content/docs/get-started/run-in-the-cloud/marketplaces/_paid-features.mdx';
 

@@ -1,9 +1,9 @@
 ---
 title: Use Cases Overview
-topOfNav: true
 description: An overview of common FusionAuth Use Cases.
 section: get started
 subcategory: use cases
+navOrder: 0
 ---
 import AuthServiceDescription from 'src/content/docs/get-started/use-cases/_auth-service-description.mdx';
 import AppSuiteDescription from 'src/content/docs/get-started/use-cases/_app-suite-description.mdx';

@@ -5,7 +5,7 @@ navcategory: login-methods
 section: lifecycle
 subcategory: authenticate users
 tertcategory: identity providers
-topOfNav: true
+navOrder: 0
 tags: authorization hub
 ---
 import Aside from 'src/components/Aside.astro';

@@ -6,7 +6,7 @@ section: lifecycle
 subcategory: authenticate users
 tertcategory: integrations
 quatercategory: oidc
-topOfNav: true
+navOrder: 0
 ---
 
 While OpenID Connect (OIDC) is a standard and is broadly interoperable, this section contains examples of integrations where external applications delegate to FusionAuth for user authentication.

@@ -5,7 +5,7 @@ navcategory: developer
 section: lifecycle
 subcategory: authenticate users
 tertcategory: login api
-topOfNav: true
+navOrder: 0
 ---
 import LoginAPIIssues from 'src/content/docs/get-started/core-concepts/_login-api-issues.mdx';
 import LoginAPIScopeLimitations from 'src/content/docs/_shared/_login-api-scope-limits.mdx';

@@ -5,7 +5,7 @@ navcategory: login-methods
 section: lifecycle
 subcategory: authenticate users
 tertcategory: oauth
-topOfNav: true
+navOrder: 0
 ---
 import APIBlock from 'src/components/api/APIBlock.astro';
 import APIField from 'src/components/api/APIField.astro';

@@ -5,7 +5,7 @@ navcategory: login-methods
 section: lifecycle
 subcategory: authenticate users
 tertcategory: passwordless
-topOfNav: true
+navOrder: 0
 ---
 import { YouTube } from '@astro-community/astro-embed-youtube';
 

@@ -2,7 +2,7 @@
 title: Lifecycle Overview
 description: An overview of the CIAM lifecycle.
 section: lifecycle
-topOfNav: true
+navOrder: 0
 ---
 
 There's a lifecycle for CIAM users: 

@@ -5,7 +5,7 @@ navcategory: premium
 section: lifecycle
 subcategory: manage users
 tertcategory: account management
-topOfNav: true
+navOrder: 0
 ---
 import PremiumPlanBlurb from 'src/content/docs/_shared/_premium-plan-blurb.astro';
 import Aside from 'src/components/Aside.astro';

@@ -5,7 +5,7 @@ navcategory: premium
 section: lifecycle
 subcategory: migrate users
 tertcategory: connectors
-topOfNav: true
+navOrder: 0
 ---
 import Aside from 'src/components/Aside.astro';
 import ConnectorDiagram from 'src/diagrams/docs/lifecycle/migrate-users/connectors/_connector-diagram.astro';

@@ -3,7 +3,7 @@ title: User Data Migration
 description: Learn how can you move users to FusionAuth.
 section: lifecycle
 subcategory: migrate users
-topOfNav: true
+navOrder: 0
 ---
 import PremiumPlanBlurb from 'src/content/docs/_shared/_premium-plan-blurb.astro';
 import EnterprisePlanBlurb from 'src/content/docs/_shared/_enterprise-plan-blurb.astro';

@@ -5,7 +5,7 @@ navcategory: premium
 section: lifecycle
 subcategory: migrate users
 tertcategory: scim
-topOfNav: true
+navOrder: 0
 ---
 import EnterprisePlanBlurb from 'src/content/docs/_shared/_enterprise-plan-blurb.astro';
 import Aside from 'src/components/Aside.astro';

@@ -3,7 +3,7 @@ title: Overview
 description: Learn about FusionAuth's registration options.
 section: lifecycle
 subcategory: register users
-topOfNav: true
+navOrder: 0
 ---
 
 Registration lets you control which users have access to which applications in a tenant (authorization), in contrast to authenticating a user. [Learn more about these concepts.](/docs/get-started/core-concepts/authentication-authorization)

@@ -3,7 +3,7 @@ title: Release Notes
 description: This page contains release notes for recent versions of FusionAuth.
 section: release notes
 disableTOC: true
-topOfNav: true
+navOrder: 0
 ---
 import Breadcrumb from 'src/components/Breadcrumb.astro';
 import DatabaseMigrationWarning from 'src/components/docs/release-notes/DatabaseMigrationWarning.mdx';

@@ -4,7 +4,7 @@ description: Learn about example applications using FusionAuth.
 section: sdks
 subcategory: examples
 disableTOC: true
-topOfNav: true
+navOrder: 0
 canonicalUrl: /docs/extend/examples/example-repos
 ---
 import ExampleAppsIntro from 'src/content/docs/sdks/examples/_example_apps_intro.mdx';

@@ -2,7 +2,7 @@ export interface DocNavEntry  {
   title: string;
   href: string;
   description?: string;
-  topOfNav?: boolean;
+  navOrder?: number;
 }
 export interface DocNavContext {
   category: Category;
@@ -13,4 +13,4 @@ export interface Category {
   href: string;
   entries: DocNavEntry[];
   subcategories: Category[];
-}
+}
@@ -55,15 +55,14 @@ const prepContext = (context: DocNavContext, subcategory: string, tertcategory:
 
 const recursiveSort = (category: Category) => {
   if (category.entries.length > 0) {
-    category.entries.sort((a, b) => a.title.localeCompare(b.title));
-    const topOfNavElements = category.entries.filter(entry => entry.topOfNav);
 
-    // sort these in reverse order so we process the Z elements before the A elements, which means A elements come first
-    topOfNavElements.sort((a, b) => b.title.localeCompare(a.title));
-    topOfNavElements.map((top) => {
-      const idx = category.entries.indexOf(top);
-      category.entries.splice(idx, 1);
-      category.entries.unshift(top);
+    category.entries.sort((a, b) => {
+      // everything has a default of 1000, so sorts to bottom
+      const numCompare = a.navOrder - b.navOrder;
+      if (numCompare !== 0) {
+        return numCompare;
+      }
+      return a.title.localeCompare(b.title);
     });
   }
   if (category.subcategories.length > 0) {
@@ -84,13 +83,13 @@ export const getDocNavContext = async (section: string) => {
 
   const sectionDocs = await getCollection('docs', doc => doc.data.section === section);
   sectionDocs.forEach(doc => {
-    const { subcategory, tertcategory, quatercategory, title, description, topOfNav } = doc.data;
+    const { subcategory, tertcategory, quatercategory, title, description, navOrder } = doc.data;
     const category = prepContext(context, subcategory, tertcategory, quatercategory);
     category.entries.push({
       title,
       description,
       href: getDocHref(doc.slug),
-      topOfNav,
+      navOrder,
     })
   });
   recursiveSort(context.category);