Skip to content

axioned/handbook

Repository files navigation

Axioned Handbook

A comprehensive knowledge base and documentation for Axioned's development practices, tools, and processes.

🚀 Project Structure

.
├── public/          # Static assets
├── src/
│   ├── assets/      # Images and other media
│   ├── content/     # Documentation content
│   │   ├── docs/    # Main documentation
│   │   └── config.ts
│   └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

📚 Documentation Structure

  • src/content/docs/ contains all documentation in Markdown format
  • Each .md file becomes a route in the documentation
  • Images should be placed in src/assets/ and referenced in Markdown
  • Static assets (favicons, etc.) go in public/

🛠️ Development

All commands are run from the root of the project:

Command Action
npm install Install dependencies
npm run dev Start local dev server at localhost:4321
npm run build Build production site to ./dist/
npm run preview Preview production build locally

📝 Contributing

  1. Create a new branch for your changes
  2. Follow the Code Review Checklist
  3. Submit a PR with clear description of changes
  4. Ensure all documentation is clear and well-formatted

🔍 Need Help?

About

The Axioned Handbook is the central repository for how we run the company.

Topics

Resources

Stars

Watchers

Forks

Contributors 17