README.md

Welcome to Forge 42 Documentation Template

This template is designed to support a flexible content structure using .md and .mdx files organized into folders. It enables deeply nested sections and subsections, making it easy to manage complex documentation with a clear and scalable hierarchy.

The project is built using the @forge-42/base-stack and leverages the content-collections.

Documentation Template Structure Overview

app/

This folder contains React Router v7 web application folders and files, including components and UI primitives for the documentation site’s interface, internal hooks and utilities, and the tailwind.css file for styling.

resources/

This folder contains all the resources used by the documentation site, such as SVG icons, fonts, and other assets.

content/

This folder contains .md and .mdx files that hold your documentation content. Below is the recommended structure to follow.

An example of a valid content/ folder structure for organizing your package documentation:

content/
├── _index.mdx
├── 01-changelog.mdx
├── 02-introduction.mdx
├── 03-overview.mdx
├── 04-getting-started/
│   ├── index.md
│   ├── 01-installation.mdx
│   ├── 02-quick-start.mdx
│   └── 03-project-setup.mdx
└── 05-core-features/
    ├── index.md
    ├── 01-authentication.mdx
    ├── 02-authorization.mdx
    ├── 03-data-management/
    │   ├── index.md
    │   ├── 01-fetching-data.mdx
    │   └── 02-caching-strategies.mdx
    └── 04-ui-components/
        ├── index.md
        ├── 01-buttons.mdx
        └── 02-modals.mdx

• Top-level .mdx files (like 01-changelog.mdx) are allowed, but we recommend placing them in order before the sections, as shown in the example.

• Sections (like 04-getting-started, 05-core-features) are subfolders inside the content folder.

• Subsections (like 03-data-management, 04-ui-components) are nested folders within sections. Filenames inside them should start with 01-*.mdx.

• Each section or subsection should include an index.md file, which defines its sidebar title.

Example of the valid **/*.mdx file:

---
title: "Introduction to Forge42 Base Stack"
summary: "Overview of the Stack"
description: "Get started with the Forge42 Base Stack — a modern web app starter template designed for speed, scalability, and developer experience."
---

## What is Forge42 Base Stack?

The Forge42 Base Stack is a full-featured web application starter template. It combines modern tools and technologies like **Remix**, **Tailwind CSS**, **TypeScript**, **Vitest**, and **React Aria Components** to help you build accessible and scalable web apps quickly.

This documentation will guide you through setting up the project, understanding its structure, and customizing it for your needs.

## Installation

To get started with the base stack, simply clone the repository and install dependencies:

```bash
npx degit forge42/base-stack my-app
cd my-app
npm install

Example of the valid **/*.md file:

---
title: Getting Started
---

Getting started

1. Fork the repository

2. Install the dependencies:

pnpm install

3. Read through the README.md files in the project to understand our decisions.

4. Add content folder

5. Run pnpm run generate:docs script

6. Start the development server:

pnpm run dev

7. Happy coding!