Inside the project you'll see the following folders and files:
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
├── tailwind.config.mjs
└── tsconfig.json
Each file in the src/content/docs/ is exposed as a route based on its file name.
Images can be added to src/assets/ and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in the public/ directory.
To add new categories in the sibebar update the astro.config.mjs file.
Agents can refer to TRAIN.md for instructions on how to consume and navigate this documentation repository to understand the Torus protocol and system architecture.
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
pnpm install | Installs dependencies |
pnpm run dev | Starts local dev server at localhost:4321 |
pnpm run build | Build your production site to ./dist/ |
pnpm run preview | Preview your build locally, before deploying |
pnpm run astro ... | Run CLI commands like astro add, astro check |
pnpm run astro -- --help | Get help using the Astro CLI |