Skip to content

chore(docs): split docs agent instructions - #78

Merged
imdhemy merged 5 commits into
mainfrom
chore/update-readme-and-agents-instructions
Mar 31, 2026
Merged

chore(docs): split docs agent instructions#78
imdhemy merged 5 commits into
mainfrom
chore/update-readme-and-agents-instructions

Conversation

@imdhemy

@imdhemy imdhemy commented Mar 31, 2026

Copy link
Copy Markdown
Member

Summary

  • split repository-wide rules from published-site editorial rules by introducing docs/AGENTS.md
  • keep the root AGENTS.md focused on structure, release workflow, and review routing
  • replace the single GitHub docs agent with dedicated Author and Editor agents

Behavior Change

  • documentation and homepage content now have a dedicated editorial instruction file
  • GitHub docs automation is now split into authoring and editing roles
  • there is no user-visible change to the published site itself

Validation

  • not run; this change only updates repository instructions and GitHub agent configuration

Review Focus

  • verify the root AGENTS.md remains structural and routes content work to docs/AGENTS.md
  • verify docs/AGENTS.md is written as an operational prompt rather than a conceptual charter
  • verify the Author and Editor agents point to the correct instruction sources

Notes

  • README.md is intentionally excluded from the docs-local editorial rules
  • homepage content is intentionally included in docs/AGENTS.md scope

imdhemy added 5 commits March 31, 2026 16:06
- move published-site editorial rules into docs/AGENTS.md
- keep the root AGENTS.md focused on repository structure and review routing
- replace the single GitHub docs agent with dedicated Author and Editor agents
- replace the bare framework repository URL in docs/AGENTS.md
- keep the published-docs instruction split intact
- verify the change with npm run validate
- remove redundant markdown writing rules from docs/AGENTS.md
- keep markdownlint readiness enforced at the acceptance level
- preserve the existing published-docs instruction split
- add .github/copilot-instructions.md as a pointer to AGENTS.md and docs/AGENTS.md
- route published content and homepage work to the docs Editor standard
- route code review and repo-wide changes to the root repository instructions
@imdhemy
imdhemy merged commit 7f61831 into main Mar 31, 2026
1 check passed
@imdhemy
imdhemy deleted the chore/update-readme-and-agents-instructions branch March 31, 2026 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant