Skip to content

Commit fde34fb

Browse files
abrulicabrulic
andauthored
updated readme (#17)
Co-authored-by: abrulic <almina@forge42.dev>
1 parent af8205d commit fde34fb

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,23 @@
22

33
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.
44

5+
<p align="center">
6+
<img
7+
src="./public/static/images/docs-template-photo.png"
8+
alt="react-router-devtools"
9+
style="display:block; width:100%; height:auto; margin:0 auto;"
10+
/>
11+
</p>
12+
513
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).
614

715
> **Note**:
816
> 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.
917
18+
## Documentation
19+
Detailed documentation can be found here:
20+
21+
https://docs-main.fly.dev/
1022

1123
## Documentation Template Structure Overview
1224

@@ -89,6 +101,15 @@ title: Getting Started
89101
90102
```
91103

104+
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:
105+
106+
<p align="center">
107+
<img
108+
src="./public/static/images/docs-template-home.png"
109+
alt="react-router-devtools"
110+
style="display:block; width:100%; height:auto; margin:0 auto;"
111+
/>
112+
</p>
92113

93114
## Getting started
94115

162 KB
Loading
120 KB
Loading

0 commit comments

Comments
 (0)