-
Notifications
You must be signed in to change notification settings - Fork 24
Add comprehensive GitHub Copilot AI agent instructions for documentation repository #726
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Device | URL |
|---|---|
| desktop | http://localhost:3000/ |
| Device | URL |
|---|---|
| mobile | http://localhost:3000/ |
Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey! Thanks for the contrib. 🙏
Overall, this file looks more like developer setup notes than actual Copilot instructions.
IMHO, the purpose of he copilot-instructions.md is to guide an autonomous AI agent so it should cover the different aspects of this repo:
- CI/CD: maintain existing workflows, and evolve them only when requested (e.g. new workflows, changes in lint/build/publish).
- Docusaurus (code): understand and adapt the config, scripts, and structure, fix bugs, keep the site functional and maintainable.
- Documentation (purpose of this repo): propose, write, reorganize, and improve Axone's documentation. Content should always be aligned with the protocol's domain and context: use precise, technical terminology when describing components such as architecture, smart contracts, or governance modules, and adopt a clear, pedagogical style in sections aimed at onboarding (e.g. Getting Started, Guides). Copilot should enforce consistency in style, tone, formatting, and cross-referencing, ensuring the documentation remains both technically accurate and accessible to its intended audience...
From what I see, the documentation aspect is almost absent, while it’s actually the main purpose of this repository.
I suggest reorganizing the file so Copilot is given the right context to accomplish these activities across the three axes above. That way the instructions are actionable specifically for an AI agent, and not just human contributors.
thx!
Restructured the file to focus on AI agent instructions rather than developer setup. Now organized around three main functions: 1) Documentation content (primary purpose) with detailed writing guidelines for Axone protocol terminology and style, 2) Docusaurus codebase maintenance, and 3) CI/CD workflow management. Removed version pinning and execution times per review feedback. Commit 0a56ed3 |
0a56ed3 to
28ae32a
Compare
ccamel
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey! Thanks for your contribution. 😌
Your draft was a good starting point, just tweaked it quite a bit. Now it's more focused on what matters in this repo, imho.
Hope you don't mind 😛
…ne docs Co-authored-by: ccamel <9574336+ccamel@users.noreply.github.com>
28ae32a to
c42e875
Compare
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed instructions for working effectively in the Axone protocol documentation repository.Key Features
AI Agent-Focused Instructions
Documentation Content Guidelines
Technical Infrastructure Management
CI/CD Workflow Preservation
Comprehensive Validation Protocol
The instructions are specifically tailored for AI agents to understand the repository's primary purpose as a documentation platform while maintaining the technical infrastructure and automated workflows that support it.
Fixes #725.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.