-
Notifications
You must be signed in to change notification settings - Fork 12.8k
Added copilot instructions, AGENTS.md, improved README files #3486
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
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
…iles Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
❌ Deploy Preview for relaxed-lollipop-b6bc17 failed. Why did it fail? →
|
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
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.
Pull request overview
This pull request significantly enhances documentation and introduces comprehensive GitHub Copilot instruction files to improve both human and AI agent workflows in the al-folio repository. The changes focus on providing clearer guidance for users and automation tools, consolidating documentation, and streamlining the onboarding experience.
Changes:
- Added comprehensive Copilot instruction files (
.github/copilot-instructions.mdand path-specific.github/instructions/*.instructions.md) to guide coding agents on tech stack, build processes, file formats, and common pitfalls - Introduced
AGENTS.mdas a central hub for AI agents and automation tools, providing quick links, essential commands, and code-specific instruction references - Updated agent documentation files to reference new Copilot instructions and clarified the distinction between repository-wide and path-specific guidance
- Removed deprecated documentation files (
MAINTENANCE.md,ACCESSIBILITY.md) and updated references to point to consolidated guidance inTROUBLESHOOTING.md - Improved documentation structure with better organization, corrected escaping in table of contents, and clearer explanations across multiple files
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
.github/copilot-instructions.md |
New repository-wide Copilot instructions covering tech stack, build process, CI/CD, and common pitfalls |
.github/instructions/bibtex-bibliography.instructions.md |
New BibTeX-specific instructions for bibliography file editing and validation |
.github/instructions/javascript-scripts.instructions.md |
New JavaScript-specific instructions for scripts in _scripts/ directory |
.github/instructions/liquid-templates.instructions.md |
New Liquid template-specific instructions for _includes/ and _layouts/ files |
.github/instructions/markdown-content.instructions.md |
New Markdown content instructions for collections like _posts/, _pages/, etc. |
.github/instructions/yaml-configuration.instructions.md |
New YAML configuration instructions for _config.yml and _data/ files |
.github/workflows/copilot-setup-steps.yml |
New GitHub Actions workflow for Copilot environment setup with required dependencies |
AGENTS.md |
New central hub file for AI agents with quick links, commands, and instructions index |
.github/agents/customize.agent.md |
Updated to reference new Copilot instruction files and remove deprecated documentation references |
.github/agents/docs.agent.md |
Updated to reference new instruction files and document their purpose |
CONTRIBUTING.md |
Updated to describe new custom instruction files and Copilot environment setup |
ANALYTICS.md |
Removed Plausible and GoAccess sections, updated service descriptions and setup instructions |
CUSTOMIZE.md |
Fixed hard refresh instructions, improved collection creation guide, updated plugin ordering |
FAQ.md |
Improved formatting with backticks around technical terms in table of contents |
INSTALL.md |
Removed MAINTENANCE.md references, improved dependency management section, clarified Docker version usage |
QUICKSTART.md |
Moved video tutorial to top, improved deployment verification steps, reorganized learning resources |
README.md |
Updated table of contents escaping for ampersands |
SEO.md |
Updated table of contents escaping and removed deprecated TOC entry |
TROUBLESHOOTING.md |
Updated table of contents escaping for ampersands |
MAINTENANCE.md |
Deleted (consolidated into other documentation) |
ACCESSIBILITY.md |
Deleted (content consolidated into TROUBLESHOOTING.md) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: George Araújo <[email protected]>
Co-authored-by: Copilot <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
Signed-off-by: George Araújo <[email protected]>
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.
Pull request overview
Copilot reviewed 25 out of 25 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
This pull request introduces several documentation improvements and adds comprehensive Copilot and agent instruction files to the al-folio repository. The most significant changes are the addition of repository-wide and path-specific Copilot instructions, updates to agent documentation to reference these instructions, and improvements to the documentation structure and clarity regarding file purposes and workflows.
Copilot and Agent Instruction Enhancements:
.github/copilot-instructions.mdfile providing detailed, repository-wide setup, build, CI/CD, troubleshooting, and file format guidance for Copilot coding agents..github/instructions/bibtex-bibliography.instructions.mdwith specific instructions for editing and validating BibTeX files, including custom keywords, formatting rules, and integration with Jekyll-Scholar.customize.agent.md,docs.agent.md) to reference the new Copilot instruction files and explain their purpose and usage for both repository-wide and path-specific scenarios. [1] [2] [3] [4]Documentation Structure and Clarity Improvements:
MAINTENANCE.md,ACCESSIBILITY.md) and updating descriptions to reflect current usage. [1] [2] [3]Workflow and Validation Updates:
TROUBLESHOOTING.mdinstead of the removedACCESSIBILITY.md.These changes collectively improve the onboarding experience for both human contributors and AI agents, ensuring consistent adherence to project conventions and reducing errors.
References:
[1] [2] [3] [4] [5] [6] [7] [8]