Skip to content

docs: revise to match reality after the bootstrap arc - #7

Merged
hasansezertasan merged 1 commit into
mainfrom
chore/docs-revise
Jun 25, 2026
Merged

docs: revise to match reality after the bootstrap arc#7
hasansezertasan merged 1 commit into
mainfrom
chore/docs-revise

Conversation

@hasansezertasan

@hasansezertasan hasansezertasan commented Jun 25, 2026

Copy link
Copy Markdown
Member

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

  • README.md — real description, what's managed, where things live, contributing rules with the four required checks, pointer to CLAUDE.md.
  • docs/ci.md — corrects the (wrong) claim that GitHub Actions calls the HCP API to trigger plans; documents the four required branch protection checks; flags the brittle HCP check name (per-installation VCS-repo ID); notes that docs-only PRs get a single SUCCESS rollup from HCP (we tested this on the previous docs PR).
  • docs/state.md — workspaces table lists what each one really manages + its path filter; adds an "API access" section showing how to read the HCP token from `~/.terraform.d/credentials.tfrc.json` and call the API directly (this is how we read plan summaries during the bootstrap).
  • docs/secrets.md — trims Cloudflare token scopes to what's actually used; notes the separate short-lived discovery token for cf-terraforming; includes the HCP user API token row that was missing.
  • docs/setup.md — drops unused steps (`TF_API_TOKEN` is unused today); reframes local dev around the CLI `plan` allowed / `apply` blocked behavior of VCS-connected workspaces; adds a Troubleshooting section covering the three real issues we hit: HCP webhook subscription drift, GitHub Pages cert wedge (toggle custom domain), and the docs-only PR + branch protection interaction.
  • docs/import.md — clarifies CLI `plan` allowed vs `apply` blocked; adds "What we've actually used this for" section documenting scope decisions made during import (excluded personal Pages projects, empty R2 bucket).
  • terraform/README.md — refreshes layout to show per-category files (dns.tf, repos.tf, branch_protection.tf, labels.tf); drops the "scaffolding" framing now that real resources exist; notes the deferred HCP-as-code option.

Test plan

  • No unintended Salt mentions (`grep -rn -iE 'salt|pillar' --include='*.md'` returns only the two intentional callouts in README and CLAUDE).
  • All cross-references between docs still resolve.
  • HCP rolls up to SUCCESS (docs-only PR, no workspace runs).
  • CI checks green; safe to merge.

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
hasansezertasan merged commit 1c37f74 into main Jun 25, 2026
4 checks passed
@hasansezertasan
hasansezertasan deleted the chore/docs-revise branch June 25, 2026 15:25
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