docs: add AGENTS.md and create roadmap issues (#36-#41)#42
Merged
Conversation
## What
1. `AGENTS.md` (~400 lines) at the repo root, modeled on the global
`~/.config/opencode/AGENTS.md` but project-specific. Sections:
- What this project is (architecture diagram)
- Repository layout (annotated file tree)
- The SIN-Code stack (4 repos: WebUI/Bundle/Brain/Context-Bridge)
- 8 hard rules (each traceable to a real bug we hit)
- Workflow conventions (Conventional Commits, force-push protocol,
PR-linkage-bug workaround)
- sin-brain (when to query / write / NOT to)
- 4 common-task recipes
- Out-of-scope list
- Open follow-ups (links to issues #36-#41)
- Quick health check (the same one we've been using)
2. 6 new tracking issues for the live roadmap:
- #36 `pnpm tsc --noEmit` + `pnpm lint` in CI
- #37 vitest setup + unit tests for lib/sin/client.ts
- #38 CODEOWNERS file
- #39 real `/api/publish` behind the Publish button
- #40 collapsible app-sidebar
- #41 `AGENTS.md` itself (this commit)
3. 26 closed issues got a 'Status update' comment with a pointer
to the new roadmap issues, so anyone reading the issue history
knows where the open work lives.
## Verification
- pnpm tsc --noEmit → exit 0
- secret scan on staged diff → 0 hits
- AGENTS.md renders correctly on GitHub (verified locally with cat)
CEO Audit — Not applicableThis repository is a Node.js / TypeScript project. Recommended checks for this repo:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #41. Adds the project-local agent rules file (~400 lines) and 6 new tracking issues for the live roadmap. 26 closed issues got status-update comments pointing at the new issues.