Skip to content

update-docs.md

Latest commit

 

History

History
66 lines (42 loc) · 2.33 KB

update-docs.md

File metadata and controls

66 lines (42 loc) · 2.33 KB

📖 Regular Documentation Update

For an overview of all available workflows, see the main README.

The update documentation workflow will run on each push to main to try to update documentation in the repository. It defaults to using [Astro Starlight] (https://starlight.astro.build) for documentation generation, but you can edit it to use other frameworks if necessary.

Installation

# Install the 'gh aw' extension
gh extension install github/gh-aw

# Add the Update Docs workflow to your repository
gh aw add githubnext/agentics/update-docs

This walks you through adding the workflow to your repository.

You can start a run of this workflow immediately by running:

gh aw run update-docs

Mandatory Checklist

  • I will review all pull requests very carefully, and carefully monitor the repository.

Configuration

This workflow requires no configuration and works out of the box. You can configure documentation frameworks, documentation structure, themes, files, directories by editing the workflow file.

After editing run gh aw compile to update the workflow and commit all changes to the default branch.

What it reads from GitHub

  • Repository contents and source code
  • Issues and their metadata
  • Actions workflow runs and results
  • Checks and status information

What it creates

  • Creates pull requests with documentation updates
  • Creates new branches for the documentation changes
  • Makes file changes to update or add documentation
  • Requires contents: write and pull-requests: write permissions

What web searches it performs

  • Searches for information to help improve documentation
  • May look up best practices, examples, or technical references

Human in the loop

  • Review documentation update pull requests for accuracy and clarity
  • Validate that documentation changes reflect actual code behavior
  • Edit and improve AI-generated documentation before merging
  • Test documentation examples and instructions for correctness
  • Disable or uninstall the workflow if documentation updates are not improving quality

Activity duration

  • By default this workflow will trigger for at most 30 days, after which it will stop triggering.
  • This allows you to experiment with the workflow for a limited time before deciding whether to keep it active.