🦩 Setup: Flamingo Code Documentation - #33
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🦩 Flamingo Code Documentation Setup
This PR adds the GitHub Actions workflow required for automated documentation generation.
What this workflow does
The 🦩 Flamingo Code Documentation pipeline generates comprehensive documentation for your codebase:
.mdfiles next to source classes explaining their purposeSetup 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.
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 hubDOC_ORCH_GITHUB_PAT— installation token for cross-repo cloneYOUTUBE_API_KEY— optional, only if YouTube integration is enabledThe 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