Function buildIndexDoc

scripts/docs/src/generate-cli-docs.ts:548–589

(commands: Command[], rootName: string)

}

function buildIndexDoc(commands: Command[], rootName: string): CommandDoc {
  const root: Root = {
    type: "root",
    children: [
      createHeading(2, "Introduction"),
      createParagraph(
        `This page aggregates CLI reference docs for ${rootName} commands.`,
      ),
    ],
  };

  commands.forEach((command) => {
    root.children.push(
      ...buildCommandSection({
        command,
        rootName,
        ancestors: [],
        depth: 2,
        useRootIntro: false,
      }),
    );
  });

  const markdown = toMarkdown(root);
  const frontmatter = [
    FRONTMATTER_DELIMITER,
    `title: ${formatYamlValue(`${rootName} CLI reference`)}`,
    "seo:",
    "  noindex: true",
    FRONTMATTER_DELIMITER,
    "",
  ].join("\n");

  const mdx = `${frontmatter}${markdown}\n`;

  return {
    fileName: "index.mdx",
    markdown,
    mdx,
    commandPath: `${rootName} (index)`,
  };
}

async function main(): Promise<void> {
  const repoRoot = getRepoRoot();