Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,23 @@

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.

<p align="center">
<img
src="./public/static/images/docs-template-photo.png"
alt="react-router-devtools"
style="display:block; width:100%; height:auto; margin:0 auto;"
/>
</p>

The project is built using the [@forge-42/base-stack](https://github.com/forge-42/base-stack) and leverages the [content-collections](https://github.com/sdorra/content-collections).

> **Note**:
> We added a few `FIXME` comments in the codebase as notes to you. These simply mark small places where we expect you to make changes. Nothing major — it should only take you 2 minutes to go through them.

## Documentation
Detailed documentation can be found here:

https://docs-main.fly.dev/

## Documentation Template Structure Overview

Expand Down Expand Up @@ -89,6 +101,15 @@ title: Getting Started

```

We have already handled creating the sidebar for you, so based on your content, you will get a modern, automatically generated sidebar that looks like this:

<p align="center">
<img
src="./public/static/images/docs-template-home.png"
alt="react-router-devtools"
style="display:block; width:100%; height:auto; margin:0 auto;"
/>
</p>

## Getting started

Expand Down
Binary file added public/static/images/docs-template-home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/static/images/docs-template-photo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading