Skip to content

🦩 Update: Flamingo Code Documentation - #68

Merged
michaelassraf merged 1 commit into
mainfrom
setup/flamingo-ai-technical-writer
Sep 10, 2026
Merged

🦩 Update: Flamingo Code Documentation#68
michaelassraf merged 1 commit into
mainfrom
setup/flamingo-ai-technical-writer

Conversation

@flamingo

@flamingo flamingo Bot commented Sep 10, 2026

Copy link
Copy Markdown

🦩 Flamingo Code Documentation Update

This PR refreshes the existing GitHub Actions workflow with the latest template from the dashboard (renamed steps, updated script hashes, new model id, …).

What this workflow does

The 🦩 Flamingo Code Documentation 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 dashboard provisions them for you, you don't paste them by hand.

  1. Merge this PR.
  2. In the Multi-Platform-Hub admin dashboard, open this repository and 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 → 🦩 Flamingo Code Documentation → 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 Flamingo Code Documentation setup wizard

This workflow enables automated documentation generation using the
🦩 Flamingo Code Documentation pipeline. It runs on repository_dispatch events
triggered by the multi-platform-hub.

No secrets required - all credentials are passed securely at runtime.
@michaelassraf
michaelassraf merged commit c4bd28c into main Sep 10, 2026
4 checks passed
@flamingo
flamingo Bot deleted the setup/flamingo-ai-technical-writer branch September 10, 2026 18:23
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.

1 participant