Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@
This folder stores the project's long-term memory.
Keep pages concise and update them whenever the code changes.
Link documents to each other so topics remain easy to explore.

See [index](index.md) for the main chapters and consult `docs/buffer.md` for any
temporary notes. The [knowledge ethics](knowledge-ethics.md) page lists guiding
principles for trustworthy content.
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Welcome

This documentation provides the vision for the Codex Brutal template and the rules the agent must follow.
This documentation outlines the vision for the Codex Brutal template and the rules the agent must follow.

- [Knowledge Ethics](./knowledge-ethics.md)
- [VitePress](./vitepress.md)
- [Roadmap](./roadmap.md)

For an overview of all files see [README](README.md). Feedback and improvements are encouraged so every chapter stays current.

The GitHub Pages site displays this page as the home page.
1 change: 1 addition & 0 deletions docs/knowledge-ethics.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ This document adapts the French **"Manifeste pour l'éthique de la connaissance"
10. **Commitment to improvement** – Practices evolve continually to uphold these ethical standards.

By following these guidelines, the project promotes an environment where code, data and ideas can be trusted and built upon by the community.
Return to this list whenever documentation is revised so improvements remain aligned with these principles.
2 changes: 2 additions & 0 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ This document tracks the main steps planned to evolve the template.
## Long-term goals
- Turn this prototype into a full platform usable by various AI agents.
- Extend test coverage and documentation to ease external contributions.

This roadmap evolves with feedback from contributors and testing results. Review it often to track progress.
2 changes: 2 additions & 0 deletions docs/vitepress.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,5 @@ npm install vitepress --save-dev
- Markdown support and live component preview
- HMR via Vite
- Customizable static site generation

Refer to the [VitePress docs](https://vitepress.vuejs.org/) for advanced setup options.
Loading