🔧 Setup: Add Doc Orchestrator Workflow by flamingo[bot] · Pull Request #40 · flamingo-stack/rmmagent · GitHub
Skip to content

🔧 Setup: Add Doc Orchestrator Workflow#40

Open
flamingo[bot] wants to merge 1 commit into
developfrom
setup/doc-orchestrator-workflow
Open

🔧 Setup: Add Doc Orchestrator Workflow#40
flamingo[bot] wants to merge 1 commit into
developfrom
setup/doc-orchestrator-workflow

Conversation

@flamingo

@flamingo flamingo Bot commented May 28, 2026

Copy link
Copy Markdown

Doc Orchestrator Setup

This PR adds the GitHub Actions workflow required for automated documentation generation.

What this workflow does

The Doc Orchestrator pipeline generates comprehensive documentation for your codebase:

  1. Inline Documentation - Creates .md files next to source classes explaining their purpose
  2. CodeWiki Analysis - Generates architecture overview and module documentation
  3. AI Tutorial Generator - Claude-powered getting started guides and how-to tutorials

Setup steps

After merging this PR, the workflow needs repository secrets to run. The Doc Orchestrator dashboard provisions them for you — you don't paste them by hand.

  1. Merge this PR.
  2. In the Multi-Platform-Hub admin dashboard → Doc Orchestrator → this repo, click Sync Secrets.
    This sealed-box-encrypts and pushes the following secrets via GitHub's secrets API:
    • ANTHROPIC_API_KEY — Claude (Stages 1, 3, 4)
    • OPENAI_API_KEY — CodeWiki (Stage 2)
    • DOC_ORCH_WEBHOOK_SECRET — authenticates callbacks to the hub
    • DOC_ORCH_GITHUB_PAT — installation token for cross-repo clone
    • YOUTUBE_API_KEY — optional, only if YouTube integration is enabled
  3. Click Run Pipeline in the dashboard, or trigger manually via Actions → Doc Orchestrator Pipeline → Run workflow.

The pipeline will fail with an authentication error if you skip step 2.

Files added

  • .github/workflows/doc-orchestrator.yml - The GitHub Actions workflow

🤖 Generated by Doc Orchestrator setup wizard

This workflow enables automated documentation generation using the
Doc Orchestrator pipeline. It runs on repository_dispatch events
triggered by the multi-platform-hub.

No secrets required - all credentials are passed securely at runtime.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants