jacob-mathison/llm-tools
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update nested READMEs in tools/, documents/, agents/ to reflect current contents

Browse Source
This commit is contained in:
Jacob Mathison
2026-05-31 00:07:27 -05:00
parent 2a8c00f80b
commit e003865672
3 changed files with 52 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documents/README.md
+11 -3
View File
@@ -2,11 +2,19 @@
Reference documents, specs, and written context for AI agents working in this environment.
> This folder is a placeholder — add project specs, architecture docs, onboarding docs, and written context here as they are developed.
## Contents
## Intended Contents
| File | What it covers |
|------|---------------|
| [`onboarding.md`](./onboarding.md) | Step-by-step start-here checklist for new agents — network, git, AWS, k8s, red lines |
| [`machines.md`](./machines.md) | Full machine inventory — Tabitha, Orson, Ozymandias, Hunter, GoatLord — hardware, roles, connection patterns |
## Adding a New Document
Create a `<name>.md` file in this folder, then update `documents/README.md` and `manifest.json`.
Intended future contents:
- Project specifications and requirements
- Architecture overviews
- Onboarding documents for specific projects
- Coding standards and conventions
- Meeting notes or decision logs relevant to AI context