Skip to content

docs: add operations + rotation playbooks, recipes, limits, API toolkit - #10

Merged
hasansezertasan merged 1 commit into
mainfrom
docs/expand
Jun 25, 2026
Merged

docs: add operations + rotation playbooks, recipes, limits, API toolkit#10
hasansezertasan merged 1 commit into
mainfrom
docs/expand

Conversation

@hasansezertasan

@hasansezertasan hasansezertasan commented Jun 25, 2026

Copy link
Copy Markdown
Member

Summary

Expands the docs/ layer from "what this is" to "how to run it" with seven additions and an index. The big swing is moving from first-contact orientation (covered by #9) into operational reference: when something breaks, when something needs adding, when a token rotates, what each vendor limit is, and how to drive HCP from CLI.

What's new

File Purpose
docs/rollback.md Six ranked options when apply goes wrong: revert, discard, cancel, state surgery, admin override, rebuild.
docs/recipes.md Copy-paste recipes for the five tasks future-you will do most often: add DNS record, add repo, add label, bump provider, cross-workspace change.
docs/limits.md Free-tier ceilings on HCP, Cloudflare, GitHub, Let's Encrypt with current usage and cliffs to watch.
docs/hcp-api.md REST API toolkit. Every `curl` we used during the bootstrap, generalised and reusable.
docs/worktree-workflow.md Optional `git worktree` convention for maintainers juggling branches.
docs/README.md Index of every doc with one-line hooks and a reading order.

What's extended

  • `docs/secrets.md` Rotation section: from one-line-per-credential into step-by-step zero-downtime procedures with "no plan, no revoke" verification.
  • `terraform/README.md` Conventions section: lock file committed, label naming, file-per-category split, provider pin policy (`~> X.Y`), cross-leaf references hedge.

Test plan

Pairs with

After this lands, the docs/ surface is opinionated, indexed, and operationally complete enough that the next agent can pick up issue #8 cold with full context.

Expands the docs/ layer from "what this is" to "how to run it" with
seven additions / extensions, plus an index so the surface stays
navigable as it grows.

Added:
- docs/rollback.md          — six ranked options when apply goes
                              wrong: revert, discard, cancel,
                              state surgery, admin override, rebuild.
- docs/recipes.md           — copy-paste recipes for the five
                              tasks future-you will do most: add
                              DNS record, add repo, add label, bump
                              provider, cross-workspace change.
- docs/limits.md            — free-tier ceilings on HCP, Cloudflare,
                              GitHub, Let's Encrypt with current
                              usage and the cliffs to watch.
- docs/hcp-api.md           — REST API toolkit: workspace lookup,
                              plan summary, confirm/discard/cancel,
                              variable listing, manual plan trigger.
                              Every script we used during the
                              bootstrap, generalised and reusable.
- docs/worktree-workflow.md — optional git worktree convention
                              for maintainers juggling branches.
- docs/README.md            — index of every doc with a one-line
                              hook and a reading order for first
                              contact. Stops the docs surface from
                              becoming a flat directory listing.

Extended:
- docs/secrets.md           — Rotation section turned from
                              one-line-per-credential into step-by-
                              step zero-downtime procedures with
                              "no plan, no revoke" verification.
- terraform/README.md       — Conventions section: lock file is
                              committed, label naming, file-per-
                              category split, provider pin policy
                              (~> X.Y), cross-leaf references hedge.

Pairs with #9 (CONTRIBUTING.md) and Issue #8 (HCP-as-code) so the
next session can pick up either thread with full operational
context, not just first-contact orientation.
@hasansezertasan
hasansezertasan merged commit 7df59ff into main Jun 25, 2026
4 checks passed
@hasansezertasan
hasansezertasan deleted the docs/expand branch June 25, 2026 16:04
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