Add daily documentation updater workflow#1861
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
pelikhan
reviewed
Oct 17, 2025
|
|
||
| Scan the repository for merged pull requests and code changes from the last 24 hours, identify new features or changes that should be documented, and update the documentation accordingly. | ||
|
|
||
| ## Current Context |
Copilot
AI
changed the title
[WIP] Update documentation with features from the last 24 hours
Add daily documentation updater workflow
Oct 17, 2025
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
|
Agentic Changeset Generator triggered by this pull request. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds a new agentic workflow that automatically keeps documentation up-to-date by scanning merged pull requests and code changes from the last 24 hours, then updating the documentation accordingly.
Motivation
As the project evolves with new features and changes, documentation can quickly fall out of sync with the codebase. This workflow automates the documentation maintenance process by:
Implementation
Workflow File:
.github/workflows/daily-doc-updater.mdThe workflow runs daily at 9am UTC (or can be triggered manually) and performs the following steps:
.github/instructions/documentation.instructions.mdto ensure consistency with the Diátaxis framework and Astro Starlight syntaxdocs/src/content/docs/to determine which files need updatesConfiguration
Engine: Claude with network access to GitHub domains
Permissions: Read-only (
contents: read,pull-requests: read,actions: read)Tools:
Safe Outputs: Configured to create pull requests with:
[docs]documentation,automationExample Output
When features are merged, the workflow creates a PR like:
Title:
[docs] Update documentation for features from 2025-10-17Description:
Edge Cases
The workflow handles several edge cases gracefully:
Testing
Files Changed
.github/workflows/daily-doc-updater.md- Main workflow definition.github/workflows/daily-doc-updater.lock.yml- Generated GitHub Actions workflowThe workflow is now ready to run and will help maintain documentation quality automatically.
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.