mirror of
https://github.com/PR0M3TH3AN/TORCH.git
synced 2026-11-04 11:51:53 +00:00
docs(agent): audit and improve documentation (docs-agent)
- Created `CONTRIBUTING.md` with development instructions. - Updated `README.md` to include a Development section. - Added daily scheduler run artifacts. - Completed scheduler cycle for `docs-agent`. Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
1 parent
f343af246f
commit
f436beab9b
13 files changed
+193
-51
No files matched your search
@@ -0,0 +1,18 @@
|
||||
# Context: Docs Agent Run 2026-02-18
|
||||
|
||||
The `docs-agent` was selected to audit and improve documentation.
|
||||
|
||||
## Goals
|
||||
1. Audit `README.md` and other docs against the codebase.
|
||||
2. Improve Quickstart instructions.
|
||||
3. Create `CONTRIBUTING.md` if missing.
|
||||
|
||||
## Findings
|
||||
- `AGENTS.md` is missing.
|
||||
- `docs/event-schemas.md` and `docs/runtime-fallback.md` are missing.
|
||||
- `package.json` lacks a `format` script.
|
||||
- `README.md` lacked a clear development quickstart.
|
||||
|
||||
## Actions Taken
|
||||
- Created `CONTRIBUTING.md` with verified commands (`npm install`, `npm run build`, `npm test`, `npm run lint`).
|
||||
- Updated `README.md` to link to `CONTRIBUTING.md` and provide a quick start.
|
||||
Reference in new issue
Block a user