put index first

Author: avivkeller

src/generators/jsx-ast/constants.mjs

@@ -86,3 +86,10 @@ export const AST_NODE_TYPES = {
     EXPRESSION_STATEMENT: 'ExpressionStatement',
   },
 };
+
+// These positions are explicity before anything else
+export const OVERRIDDEN_POSITIONS = [
+  'index', // https://github.com/nodejs/node/blob/main/doc/api/index.md
+  'synopsis', // https://github.com/nodejs/node/blob/main/doc/api/synopsis.md
+  'documentation', // https://github.com/nodejs/node/blob/main/doc/api/documentation.md
+];

src/generators/jsx-ast/index.mjs

@@ -1,3 +1,4 @@
+import { OVERRIDDEN_POSITIONS } from './constants.mjs';
 import buildContent from './utils/buildContent.mjs';
 import {
   getCompatibleVersions,
@@ -34,7 +35,19 @@ export default {
     // Get sorted primary heading nodes
     const headNodes = entries
       .filter(node => node.heading.depth === 1)
-      .sort((a, b) => a.heading.data.name.localeCompare(b.heading.data.name));
+      .sort((a, b) => {
+        const ai = OVERRIDDEN_POSITIONS.indexOf(a.api),
+          bi = OVERRIDDEN_POSITIONS.indexOf(b.api);
+        // If this is in OVERRIDDEN_POSITIONS, it must come first
+        return ai !== -1 && bi !== -1
+          ? ai - bi
+          : ai !== -1
+            ? -1
+            : bi !== -1
+              ? 1
+              : // Just compare headings
+                a.heading.data.name.localeCompare(b.heading.data.name);
+      });
 
     // Generate table of contents
     const docPages = headNodes.map(node => [