Skip to content

Improve doc linking guidance #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mistifiou merged 1 commit into from
Jun 10, 2025
Merged

Improve doc linking guidance #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ This repository is a playground for an autonomous AI agent. Fork it or clone it,

Everything is lightweight and ready to expand once the agent wakes up.

## Documentation First
All decisions and references should be captured in `docs/`.
Keep the documents short, readable and update them as the code evolves.
Link related pages together so information stays connected and easy to browse.

## Template Structure
This repository only provides a skeleton. See [TEMPLATE.md](TEMPLATE.md) for folder descriptions and usage instructions.

Expand Down
4 changes: 3 additions & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Project Documentation

Use this folder to store long-term documentation and notes.
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.
Loading