Skip to content

feat: add generate-docs command for PR-based documentation#3867

Draft
Bishibop wants to merge 1 commit intomainfrom
update-generate-docs-command
Draft

feat: add generate-docs command for PR-based documentation#3867
Bishibop wants to merge 1 commit intomainfrom
update-generate-docs-command

Conversation

@Bishibop
Copy link

@Bishibop Bishibop commented Mar 5, 2026

Summary

Adds a Claude Code slash command (/generate-docs) that analyzes GitHub PRs and generates documentation following the Replicated style guide.

Features

  • Fetches PR details and diffs from GitHub
  • Categorizes changes by code path (features, CLI, custom resources)
  • Searches existing docs to determine if updates or new files are needed
  • Generates documentation following the style guide from README.md
  • Self-reviews content before presenting to user
  • Creates draft PRs with proper formatting

Exclusions

Vendor API (handlers/vendor-api/*) and Market API (handlers/market-api/*) changes are excluded as those docs are auto-generated from OpenAPI specs.

Usage

/generate-docs https://github.com/replicatedhq/replicated/pull/12345

Adds a Claude Code slash command that analyzes GitHub PRs and generates
documentation following the Replicated style guide.

Excludes vendor-api and market-api changes as those docs are auto-generated.
@Bishibop Bishibop requested a review from a team as a code owner March 5, 2026 21:36
@netlify
Copy link

netlify bot commented Mar 5, 2026

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit 7d42938
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs/deploys/69a9f753fc97bc00087db73e
😎 Deploy Preview https://deploy-preview-3867--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Mar 5, 2026

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit 7d42938
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs-upgrade/deploys/69a9f7531b250c0008725769
😎 Deploy Preview https://deploy-preview-3867--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Mar 5, 2026
@Bishibop Bishibop self-assigned this Mar 6, 2026
@paigecalvert paigecalvert marked this pull request as draft March 11, 2026 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type::docs Improvements or additions to documentation type::feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants