redhat-community-ai-tools/Upstream Documentation Enhancer

AI-powered documentation enhancer that automatically updates docs based on code changes

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
model-api-baseBase URL for an OpenAI-compatible API (e.g. vLLM on OpenShift AI, Gemini, etc.)yes
model-api-keyAPI key for the model endpoint (leave empty if not required)no""
model-nameModel name to use for inference (e.g. meta-llama/Llama-3.1-8B-Instruct, gemini-2.0-flash)yes
docs-repo-urlURL of the documentation repositoryyes
github-tokenGitHub token for creating PRsyes
dry-runSimulate changes without writing files or pushing PRnofalse
pr-numberPull request numberno
pr-baseBase branch for PR comparison (e.g. origin/main)noorigin/main
pr-head-shaHead reference/SHA for the PRno
docs-subfolderOptional: relative path to docs subfolder within the same repository (e.g., "docs", "content/docs")no""
docs-base-branchBase branch for docs repository PRs (e.g., "main" or "master")nomain
comment-bodyThe comment body text (used to detect [review-docs], [update-docs], or [review-feature] commands)no""
jira-urlJira instance URL (e.g., https://your-company.atlassian.net). Required for [review-feature].no""
jira-usernameJira username/email for API authentication. Required for [review-feature].no""
jira-api-tokenJira API token for authentication. Required for [review-feature].no""
google-sa-keyOptional: Google service account JSON key for fetching Google Docs linked in Jira tickets. If not provided, Google Docs links will be flagged but content will not be fetched.no""
max-context-charsMaximum characters for LLM prompt content (default: 400000, ~100K tokens). Decrease for models with smaller context windows (e.g. 32000 for an 8K-token model).no400000
style-config-pathPath to a Markdown style configuration file (.md) containing documentation style guidelines. If not set, auto-detects .code-to-docs/style.md in the repository root.no""
namedescription
statusStatus of the documentation enhancement
modified-filesJSON array of modified files
pr-createdWhether a PR was created