Add agent docs#32
Open
HeyItsGilbert wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for powershellorg ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds repository-scoped documentation to help AI agents operate consistently in this Hugo site repo (issue-tracker usage, triage label mapping, and how to consume domain docs/ADRs), plus a small repo housekeeping change.
Changes:
- Add
AGENTS.mdas the entrypoint for agent instructions and link out to more detailed agent docs. - Add
docs/agents/*documentation covering GitHub issue tracker conventions, triage label mapping, and domain/ADR reading guidance. - Remove a local-only
.claude/settings.local.jsonfile; add an empty Front Matter DB file (mediaDb.json).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/agents/triage-labels.md | Documents canonical triage roles and their label-string mapping for this repo. |
| docs/agents/issue-tracker.md | Documents gh CLI conventions for issue tracker operations. |
| docs/agents/domain.md | Documents how agents should use CONTEXT.md and ADRs when exploring/changing the repo. |
| AGENTS.md | Adds a single top-level entrypoint that points agents to the detailed docs. |
| .frontmatter/database/mediaDb.json | Adds an empty Front Matter media DB JSON file (consistent with other tracked Front Matter DBs). |
| .claude/settings.local.json | Removes local Claude settings from the repo. |
| ## Conventions | ||
|
|
||
| - **Create an issue**: `gh issue create --title "..." --body "..."`. Use a heredoc for multi-line bodies. | ||
| - **Read an issue**: `gh issue view <number> --comments`, filtering comments by `jq` and also fetching labels. |
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
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.
Built using Matt Pococks skills. This just makes the agent keep track of context, adr's, and how to create issues, etc. It's a nice to have (to keep all agents acting the same), but not a huge deal if we want to keep the repo clean.