Repository navigation
Conversation
Update docs to match changes since v0.4.0 and the October redesign: - Fix broken CLI commands (reset-password flags, docker compose run, export) - Document setup code for the first admin and version-specific upgrade steps - Rewrite notifications for per-event subscriptions - Update architecture pages (deploy dropdown, health/agent states, dashboard, history) - Add missing env vars, security mechanisms and OIDC settings - Fix webhooks, GitHub Actions, reverse proxy and contributing guides - Replace outdated screenshots and add new ones
timokoessler
requested changes
Oct 21, 2026
timokoessler
left a comment
timokoessler
left a comment
Member
There was a problem hiding this comment.
I didn't read everything yet :D
- Describe less UI detail on the applications, agents and repositories pages - Link to CONTRIBUTING.md for tool versions and use just -l instead of listing commands - Move setup code log level hint to common issues - Drop overly specific sentences from installation, reverse proxy and GitHub Actions guides - Clarify that offline agents can be deleted
- Add new advanced/tailscale.mdx guide covering host and sidecar setups, Agent connections, access control, Funnel, and internal service access - Fix invalid `//` code annotations in reverse-proxy.mdx labels block to use `#`
This branch has not been deployed
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
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.
The docs were last updated on 2026-07-21 and had drifted from the code since v0.4.0 and the October changes. This PR brings every page in line with
mainof OrcaCD/orca-cd. Each change was checked against the code.Broken instructions
reset-passwordtakes--email/--id, not a positional argument (CLI docs, account recovery, terminal demo)docker compose runexamples no longer repeat/app/hub(the entrypoint already is/app/hub)upgrading:backup→exportmap $http_upgrade $connection_upgradeblocksyncRepodefaults tofalse; the example YAML is now validNew / changed behaviour
HUB_URLfor local testing, recreate the agent after changingAUTH_TOKENStoppedandErrorstates, overview dashboard, history timeline and search, versions,compose.override.yaml, supported providers, wizard flow, delete/move behaviourCA_CERT_FILE,HEALTHCHECK_PORT,DEPLOYMENTS_DIR,OLD_APP_SECRET, plus the constraints onAPP_SECRET,APP_URLandHUB_URLScreenshots
Replaced all outdated screenshots and added 11 new ones, taken from the current UI using frontend mock data.
Behaviour introduced after v0.4.0 (setup code, new nonce format, stricter policy) is not released yet. The
latestimage only covers v0.4.0. The upgrade page phrases it as "Upgrading from v0.4.0 to a newer version". Consider merging this together with the next release.