Documentation

Documentation guide for your application.

BuilderHack is one of the few boilerplates that offer you an very easy way to build a documentation for your application. Under docs you can find all the structure to create your documentation. The pages you'll write for the documentation are located inside contents/docs/. Each folder represents a different section of your documentation. So you can organize your documentation into multiple sections and subsections easily.

This structure was implemented using Aria-Docs, a powerful documentation generator for modern web applications. Here you several examples on how implement documentation in your project.

All the routes are configured in src/lib/routes-config.ts, so you can easily add or remove sections and subsections as needed.

export const ROUTES: EachRoute[] = [
  {
    title: "Getting Started",
    href: "/getting-started",
    noLink: true,
    items: [
      { title: "Introduction", href: "/introduction" },
      { title: "Installation", href: "/installation" },
    ],
  },
  {
    title: "Features",
    href: "/features",
    noLink: true,
    items: [
      { title: "Authentication", href: "/authentication" },
      { title: "Stripe payments", href: "/stripe-payments" },
      { title: "Email", href: "/email" },
      { title: "Analytics", href: "/analytics" },
      { title: "Documentation", href: "/documentation" },
      { title: "Internationalization", href: "/internationalization" },
      { title: "Deployment", href: "/deployment" },
    ],
  },
  {
    title: "Components",
    href: "/components",
    noLink: true,
    items: [
      { title: "Stripe payments", href: "/stripe-payments" },
    ],
  },
];