Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 8, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the Axone protocol documentation repository.

Key Features

AI Agent-Focused Instructions

  • Structured around three main functions: documentation content creation (primary purpose), Docusaurus codebase maintenance, and CI/CD workflow management
  • Actionable guidance specifically designed for autonomous AI agents rather than human developers
  • Comprehensive writing standards for Axone protocol content with precise technical terminology

Documentation Content Guidelines

  • Detailed standards for creating technically accurate protocol documentation
  • Domain-specific language guidelines for decentralized AI orchestration concepts
  • Content structure requirements for different documentation types (guides, references, architecture)
  • Style consistency enforcement across all documentation sections

Technical Infrastructure Management

  • Essential commands for building, testing, and validating documentation changes
  • Docusaurus configuration and custom component development guidance
  • Quality assurance protocols including linting, building, and validation workflows
  • Support for automated dependency management via Dependabot

CI/CD Workflow Preservation

  • Instructions to maintain existing automation unless specifically requested to change
  • Quality gate requirements for all documentation changes
  • Performance monitoring and validation protocols
  • Branch naming and conventional commit standards

Comprehensive Validation Protocol

  • Automated testing scenarios for documentation changes
  • Build validation and cross-reference verification requirements
  • Search functionality and responsive design testing guidance
  • Troubleshooting guidance for known issues and expected behaviors

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.

Axone Documentation Site

Fixes #725.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@vercel
Copy link

vercel bot commented Sep 8, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Sep 10, 2025 4:49pm

Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for documentation repository Sep 8, 2025
Copilot AI requested a review from ccamel September 8, 2025 09:36
@ccamel ccamel marked this pull request as ready for review September 8, 2025 15:00
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 8, 2025

Note

Other AI code review bot(s) detected

CodeRabbit 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 skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Member

@bot-anik bot-anik left a 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

Copy link
Member

@ccamel ccamel left a 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!

@ccamel
Copy link
Member

ccamel commented Sep 9, 2025

@copilot

Copy link
Contributor Author

Copilot AI commented Sep 9, 2025

Hey! Thanks for the contrib. 🙏

Overall, this file looks more like developer setup notes than actual Copilot instructions.
...

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

Copilot AI changed the title Add comprehensive GitHub Copilot instructions for documentation repository Add comprehensive GitHub Copilot AI agent instructions for documentation repository Sep 9, 2025
Copilot AI requested a review from ccamel September 9, 2025 08:57
Copy link
Member

@ccamel ccamel left a 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 😛

Copilot AI and others added 2 commits September 10, 2025 18:45
@ccamel ccamel merged commit d9793a3 into main Sep 10, 2025
18 checks passed
@ccamel ccamel deleted the copilot/fix-725 branch September 10, 2025 16:51
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.

✨ Set up Copilot instructions

3 participants