Skip to content

Documentation instructions#2

Merged
srbouffard merged 9 commits into
canonical:mainfrom
erinecon:documentation-instruction
Dec 10, 2025
Merged

Documentation instructions#2
srbouffard merged 9 commits into
canonical:mainfrom
erinecon:documentation-instruction

Conversation

@erinecon

@erinecon erinecon commented Dec 4, 2025

Copy link
Copy Markdown
Contributor

Add two sets of instructions for custom agents to better handle documentation requests. The instructions come in two flavors:

  • assets/instructions/documentation/documentation-not-rtd.instructions.md: Instructions for documentation files that aren't part of an RTD project.
  • assets/instructions/documentation/documentation-rtd.instructions.md: Instructions for documentation files that are part of an RTD project.

Many of the sections are identical between the two files. However, some sections (like CI and testing) are unique based on the differences introduced in an RTD project.

@srbouffard srbouffard left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some very minor tyops, LGTM!
Super happy for this first contrib into the collections to be with the docs :)

Comment thread assets/instructions/documentation/documentation-not-rtd.instructions.md Outdated
Comment thread assets/instructions/documentation/documentation-rtd.instructions.md Outdated
Comment thread assets/instructions/documentation/documentation.instructions.md
@srbouffard srbouffard merged commit 3251303 into canonical:main Dec 10, 2025
2 checks passed
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.

2 participants