Skip to content

Conversation

@george-gca
Copy link
Collaborator

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:

  • Added a new .github/copilot-instructions.md file providing detailed, repository-wide setup, build, CI/CD, troubleshooting, and file format guidance for Copilot coding agents.
  • Introduced .github/instructions/bibtex-bibliography.instructions.md with specific instructions for editing and validating BibTeX files, including custom keywords, formatting rules, and integration with Jekyll-Scholar.
  • Updated agent documentation files (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:

  • Clarified and reorganized the documentation file list in agent files, removing references to deprecated or merged files (e.g., MAINTENANCE.md, ACCESSIBILITY.md) and updating descriptions to reflect current usage. [1] [2] [3]
  • Enhanced documentation on the purpose and application of each documentation file, and added detailed explanations of Copilot instruction files and their role in project development.

Workflow and Validation Updates:

  • Updated references and descriptions for GitHub Actions workflows in agent documentation to include the Copilot environment setup and clarify pre-commit and CI/CD requirements. [1] [2]
  • Corrected references for accessibility guidance, now directing users to TROUBLESHOOTING.md instead of the removed ACCESSIBILITY.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]

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]>
@chatgpt-codex-connector
Copy link

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

@netlify
Copy link

netlify bot commented Jan 29, 2026

Deploy Preview for relaxed-lollipop-b6bc17 failed. Why did it fail? →

Name Link
🔨 Latest commit 8d013ea
🔍 Latest deploy log https://app.netlify.com/projects/relaxed-lollipop-b6bc17/deploys/697abd784b31100008c79dc5

Signed-off-by: George Araújo <[email protected]>
Copy link
Contributor

Copilot AI left a 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.md and path-specific .github/instructions/*.instructions.md) to guide coding agents on tech stack, build processes, file formats, and common pitfalls
  • Introduced AGENTS.md as 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 in TROUBLESHOOTING.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]>
Copy link
Contributor

Copilot AI left a 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.

george-gca and others added 3 commits January 28, 2026 22:51
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
@george-gca george-gca merged commit 25b7588 into alshedivat:main Jan 29, 2026
7 of 11 checks passed
@george-gca george-gca deleted the copilot-instructions branch January 29, 2026 01:56
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