Update Documentation References

To update documentation automatically when API signatures change in a pull request, analyze the PR diffs against doc frontmatter references and apply minimal edits to the affected docs. This process evaluates API signatures, renamed public types, and example correctness to ensure accuracy.

Frontmatter parsing for documentation maintenance is the process of reading metadata headers to map source files to their corresponding docs. It confirms the source-to-doc mapping, allowing tools to determine exactly which documentation requires revision when referenced code is modified.

To keep docs correct after code changes using GitHub CLI, extract PR metadata and diffs, validate the source-to-doc mappings via frontmatter, and generate minimal style-preserving edits. It then creates a follow-up PR and reports the results to a Slack thread.

Yes, you can preserve documentation style while updating API references. The update process applies only the precise documentation changes needed for accuracy, updating examples when APIs differ while maintaining the original structure and formatting of the files.

Yes, this documentation update workflow requires a shared extraction utility across multiple documentation files. It relies on these shared utilities alongside doc frontmatter references to properly confirm the source-to-doc mapping before evaluating doc-impact categories.

If follow-up PR creation fails for documentation updates, the system reports the results to the provided Slack thread and includes the generated diffs directly in the message. This ensures the team still receives the necessary documentation changes for manual application.