didericis/bot-bottle
1
0
Fork 0
Code Issues 7 Pull Requests 15 Actions Packages Projects Releases Wiki Activity

docs: surface docs-folder conventions in AGENTS.md #101

Merged
didericis merged 1 commits from docs/agents-doc-conventions into main 2026-05-28 23:30:58 -04:00
Conversation 0 Commits 1 Files Changed 1
+15 -2
didericis commented 2026-05-28 23:27:31 -04:00
Owner
Copy Link
Copy Source

Summary

AGENTS.md only had two thin "docs live in …" lines. Replace them with the conventions the docs/ READMEs establish, so an agent reading AGENTS.md learns them without spelunking.

Changes

  • The three document types — PRD / research note / decision record — with their numbering and the PRD Status: lifecycle (Draft → Active → Superseded/Retargeted).
  • The cross-cutting rule: decision rationale stays self-contained in the repo, not in Gitea issue threads.
  • Points at each per-folder README as the source of truth rather than duplicating them.

Notes

  • Docs-only, single file (AGENTS.md).
## Summary AGENTS.md only had two thin "docs live in …" lines. Replace them with the conventions the `docs/` READMEs establish, so an agent reading AGENTS.md learns them without spelunking. ## Changes - The three document types — **PRD** / **research note** / **decision record** — with their numbering and the PRD `Status:` lifecycle (Draft → Active → Superseded/Retargeted). - The cross-cutting rule: decision rationale stays self-contained in the repo, not in Gitea issue threads. - Points at each per-folder README as the source of truth rather than duplicating them. ## Notes - Docs-only, single file (`AGENTS.md`).
didericis added 1 commit 2026-05-28 23:27:33 -04:00
docs: surface docs-folder conventions in AGENTS.md
test / unit (pull_request) Successful in 34s
Details
test / integration (pull_request) Successful in 47s
Details
test / unit (push) Successful in 28s
Details
test / integration (push) Successful in 42s
Details
848515e5d4 
Replace the two thin "docs live in …" lines with the conventions the
docs/ READMEs establish: the three document types (PRD / research note
/ decision record) with their numbering and the PRD Status lifecycle,
plus the cross-cutting rule that decision rationale stays self-contained
in the repo rather than in Gitea issue threads. Points at the per-folder
READMEs as the source of truth instead of duplicating them.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
didericis merged commit 848515e5d4 into main 2026-05-28 23:30:58 -04:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
didericis-claude (didericis (claude)) didericis-codex (didericis (codex)) didericis-gemma (gemma) didericis
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: didericis/bot-bottle#101
Delete Branch "docs/agents-doc-conventions"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?