-
Notifications
You must be signed in to change notification settings - Fork 0
[S7] Write user-facing documentation #73
Copy link
Copy link
Open
Labels
documentationDocumentationDocumentationgithub-integrationGitHub App + Action integrationGitHub App + Action integrationsprint-7Sprint 7: OIDC, Observability & HardeningSprint 7: OIDC, Observability & Hardening
Description
Description
Documentation for users setting up and using the GitHub integration.
Documents
- Setup Guide — how to install the GitHub App, configure it, create your first
.krakenkey.yml - Config Reference — complete
.krakenkey.ymlschema with all options documented and examples - GitHub Action Reference — all commands, inputs, outputs with workflow examples
- Troubleshooting Guide — common issues, error messages, and fixes
- OIDC Setup Guide — keyless auth configuration
Acceptance Criteria
- All 5 documents written
- Config reference covers every field with examples
- Action reference has copy-paste workflows
- Troubleshooting covers top 10 expected issues
- Published to krakenkey.io/docs
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationDocumentationDocumentationgithub-integrationGitHub App + Action integrationGitHub App + Action integrationsprint-7Sprint 7: OIDC, Observability & HardeningSprint 7: OIDC, Observability & Hardening