docs: revise to match reality after the bootstrap arc - #7
Merged
Conversation
Sync all the docs with what the repo actually does after the bootstrap arc finished. Catches drift accumulated as we discovered how HCP, GitHub Pages, cf-terraforming, and branch protection actually behave. - README.md: real description, what's managed, where things live, pointer to CLAUDE.md for design decisions, contributing rules. - docs/ci.md: correct "plan workflow" to "HCP VCS integration runs plans, not GitHub Actions"; document the four required branch protection checks; flag the brittle HCP check name (per-installation VCS-repo ID); note that docs-only PRs get a single SUCCESS rollup. - docs/state.md: workspaces table now lists what each one really manages and its path filter; add an API access section showing how to read the HCP token from ~/.terraform.d/credentials.tfrc.json. - docs/secrets.md: trim Cloudflare token scopes to what's actually used; note the separate (short-lived) discovery token for cf-terraforming; include the HCP user API token row. - docs/setup.md: drop unused steps (TF_API_TOKEN is unused), reframe local dev around `terraform plan` from CLI working but apply not, and add a Troubleshooting section covering the three things we hit: HCP webhook drift, GitHub Pages cert wedge, and the docs-only PR + branch protection interaction. - docs/import.md: clarify CLI plan-allowed vs apply-blocked on VCS-connected workspaces; add a "what we've actually used" section documenting scope decisions made during import. - terraform/README.md: refresh layout to show per-category files (dns.tf, repos.tf, etc.); drop the "scaffolding" framing now that real resources exist; note the deferred HCP-as-code option. Net: every doc now describes what the repo does, not what it aspires to. The DDD contracts are still the source of truth; this is the version of them with two days of real-world signal applied.
hasansezertasan
force-pushed
the
chore/docs-revise
branch
from
June 25, 2026 15:23
f1340cf to
6621ad9
Compare
9 tasks
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.
Summary
Two days of bootstrap signal applied to every doc. Catches drift accumulated as we learned how HCP, GitHub Pages, cf-terraforming, and branch protection actually behave. Every doc now describes what the repo does, not what it aspired to do at scaffold time.
Per-file
Test plan