Scaffold README, docs/, and CLAUDE.md

ldraney commented

2026-06-13 15:16:57 +00:00

Owner

Type

Feature

Lineage

First ticket for project-godaddy-tofu. Establishes documentation foundation before any code work.

Repo

ldraney/godaddy-tofu

User Story

As a developer or agent
I want a README that serves as a table of contents to docs/, with CLAUDE.md symlinked to it
So that all subsequent tickets have reference documentation and agents get context automatically

Context

Follows the repo init pattern: first issue is always the docs foundation PR. README is a TOC linking to docs/ where reference material lives. CLAUDE.md symlinks to README so Claude Code agents pick up the project context. Includes mermaid architecture and pipeline diagrams.

The GoDaddy swagger specs from the godaddy-sdk repo are relevant reference — the Go client in this provider wraps the same API endpoints.

File Targets

README.md — TOC with mermaid diagrams (architecture, pipeline), usage examples, API coverage table
CLAUDE.md — symlink to README.md
docs/ — reference documentation directory
docs/api-groups.md — overview of GoDaddy API groups with endpoint counts
docs/dns-endpoints.md — P0 DNS record endpoint reference
docs/auth.md — sso-key auth guide and credential setup
docs/swagger_*.json — all 10 official GoDaddy swagger specs

Feature Flag

None.

Acceptance Criteria

README serves as table of contents linking to docs/
CLAUDE.md is a symlink to README.md
docs/ contains swagger specs and markdown reference docs
Mermaid diagrams render (architecture, pipeline)
All links resolve

Test Expectations

readlink CLAUDE.md returns README.md
All swagger JSON files parse correctly

Constraints

Done collaboratively with Lucas, not delegated to an agent
Go-focused framing (Terraform Plugin Framework, pkg/godaddy/ client)

Checklist

README.md as TOC
CLAUDE.md symlink
docs/ with swagger specs
docs/ with markdown reference docs
Mermaid diagrams

project-godaddy-tofu
project-godaddy-sdk — swagger specs sourced from this project

### Type Feature ### Lineage First ticket for `project-godaddy-tofu`. Establishes documentation foundation before any code work. ### Repo `ldraney/godaddy-tofu` ### User Story As a developer or agent I want a README that serves as a table of contents to docs/, with CLAUDE.md symlinked to it So that all subsequent tickets have reference documentation and agents get context automatically ### Context Follows the repo init pattern: first issue is always the docs foundation PR. README is a TOC linking to docs/ where reference material lives. CLAUDE.md symlinks to README so Claude Code agents pick up the project context. Includes mermaid architecture and pipeline diagrams. The GoDaddy swagger specs from the godaddy-sdk repo are relevant reference — the Go client in this provider wraps the same API endpoints. ### File Targets - `README.md` — TOC with mermaid diagrams (architecture, pipeline), usage examples, API coverage table - `CLAUDE.md` — symlink to README.md - `docs/` — reference documentation directory - `docs/api-groups.md` — overview of GoDaddy API groups with endpoint counts - `docs/dns-endpoints.md` — P0 DNS record endpoint reference - `docs/auth.md` — sso-key auth guide and credential setup - `docs/swagger_*.json` — all 10 official GoDaddy swagger specs ### Feature Flag None. ### Acceptance Criteria - [ ] README serves as table of contents linking to docs/ - [ ] CLAUDE.md is a symlink to README.md - [ ] docs/ contains swagger specs and markdown reference docs - [ ] Mermaid diagrams render (architecture, pipeline) - [ ] All links resolve ### Test Expectations - [ ] `readlink CLAUDE.md` returns `README.md` - [ ] All swagger JSON files parse correctly ### Constraints - Done collaboratively with Lucas, not delegated to an agent - Go-focused framing (Terraform Plugin Framework, pkg/godaddy/ client) ### Checklist - [ ] README.md as TOC - [ ] CLAUDE.md symlink - [ ] docs/ with swagger specs - [ ] docs/ with markdown reference docs - [ ] Mermaid diagrams ### Related - `project-godaddy-tofu` - `project-godaddy-sdk` — swagger specs sourced from this project