Skip to content

README.md

Latest commit

 

History

History
28 lines (22 loc) · 857 Bytes

README.md

File metadata and controls

28 lines (22 loc) · 857 Bytes

AxOS docs

This is the code of the official documentation of AxOS.

We welcome contributions to the official AxOS documentation!
Documentation pages are organized by category in src/content/docs/{category}/{page}.md.

How to Contribute

  1. Find a Page to Edit:
    Browse the docs in src/content/docs/ and pick a category or page you'd like to improve.

  2. Edit Locally:

    • Clone the repository and install dependencies: 
      git clone https://github.com/AxOS-project/docs.git
cd docs
npm install
    • Start the dev server to preview your changes: 
      npm run dev
    • Edit markdown files in the appropriate directory.

  3. Submit a Pull Request:

    • Push your changes to a new branch and open a PR.
    • Please describe what you changed and why.