-
Notifications
You must be signed in to change notification settings - Fork 43
Merge documentation unbloat style guidance and add import to technical-doc-writer workflow #2118
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
…l-doc-writer Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
| @@ -0,0 +1,153 @@ | |||
| ### Documentation | |||
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.
@copilot remove file
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.
Removed the shared/documentation.md file in commit 619028e.
| - github | ||
|
|
||
| imports: | ||
| - shared/documentation.md |
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.
@copilot documentation.instructions.md
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.
Updated import to reference ../instructions/documentation.instructions.md directly in commit 619028e.
…file directly Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
Agentic Changeset Generator triggered by this pull request. |
This PR consolidates documentation style guidance from the
unbloat-docsworkflow into the centraldocumentation.instructions.mdfile and ensures thetechnical-doc-writerworkflow imports this guidance directly.Changes Made
1. Enhanced Documentation Instructions
Added a comprehensive "Avoiding Documentation Bloat" section to
.github/instructions/documentation.instructions.mdthat includes:2. Updated Technical Documentation Writer Workflow
Modified
.github/workflows/technical-doc-writer.mdto import the documentation guidance directly from the instructions directory:This ensures the AI technical documentation writer receives comprehensive style guidance including bloat avoidance best practices when processing documentation. The workflow imports directly from the instructions file without needing an intermediate shared file.
Verification
technical-doc-writer.lock.ymlincludes all imported documentation guidanceThe technical documentation writer workflow now has access to the same concise writing guidelines used by the unbloat-docs workflow, ensuring consistency across documentation-related agentic workflows.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.