Skip to content

Commit eb27328

Browse files
authored
Update README.md
1 parent 6c56f6e commit eb27328

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,27 @@
22

33
This is the code of the official documentation of AxOS.
44

5+
We welcome contributions to the official AxOS documentation!
6+
Documentation pages are organized by category in `src/content/docs/{category}/{page}.md`.
7+
8+
### How to Contribute
9+
10+
1. **Find a Page to Edit:**
11+
Browse the docs in [`src/content/docs/`](src/content/docs) and pick a category or page you'd like to improve.
12+
13+
2. **Edit Locally:**
14+
- Clone the repository and install dependencies:
15+
```bash
16+
git clone https://github.com/AxOS-project/docs.git
17+
cd docs
18+
npm install
19+
```
20+
- Start the dev server to preview your changes:
21+
```bash
22+
npm run dev
23+
```
24+
- Edit markdown files in the appropriate directory.
25+
26+
3. **Submit a Pull Request:**
27+
- Push your changes to a new branch and open a PR.
28+
- Please describe what you changed and why.

0 commit comments

Comments
 (0)