Add CLAUDE.md symlink and complete docs/ table of contents #220

New issue

Closed

opened 2026-06-14 12:00:33 +00:00 by ldraney · 0 comments

ldraney commented

2026-06-14 12:00:33 +00:00

Owner

Type

Feature

Lineage

Standalone -- discovered during docs audit.

Repo

ldraney/landscaping-assistant

User Story

As a developer (or Claude Code agent)
I want project documentation discoverable from repo root
So that sessions start with full context and no docs are orphaned

Context

No CLAUDE.md exists in the repo, so Claude Code doesn't load project docs on session start. The README has a documentation table but is missing 6 of the 18 docs that exist in docs/: auth-strategy, keycloak-setup, feature-flags, service-requests, local-dev-setup, and dora/pipeline-timing.

File Targets

Files the agent should modify or create:

CLAUDE.md -- new symlink to README.md
README.md -- add missing doc entries to the Documentation table

Files the agent should NOT touch:

docs/* -- docs themselves are fine, only the index needs updating

Feature Flag

none

Acceptance Criteria

CLAUDE.md exists as a symlink to README.md
README documentation table includes all 18 docs in docs/
All table links resolve to existing files

Test Expectations

readlink CLAUDE.md returns README.md
All relative links in the table point to existing files
Run command: find docs -name "*.md" | wc -l matches table row count

Constraints

CLAUDE.md must be a symlink, not a copy
README remains the single source of truth

Checklist

PR opened
Tests pass
No unrelated changes

landscaping-assistant -- project this affects

### Type Feature ### Lineage Standalone -- discovered during docs audit. ### Repo `ldraney/landscaping-assistant` ### User Story As a developer (or Claude Code agent) I want project documentation discoverable from repo root So that sessions start with full context and no docs are orphaned ### Context No CLAUDE.md exists in the repo, so Claude Code doesn't load project docs on session start. The README has a documentation table but is missing 6 of the 18 docs that exist in docs/: auth-strategy, keycloak-setup, feature-flags, service-requests, local-dev-setup, and dora/pipeline-timing. ### File Targets Files the agent should modify or create: - `CLAUDE.md` -- new symlink to README.md - `README.md` -- add missing doc entries to the Documentation table Files the agent should NOT touch: - `docs/*` -- docs themselves are fine, only the index needs updating ### Feature Flag none ### Acceptance Criteria - [ ] CLAUDE.md exists as a symlink to README.md - [ ] README documentation table includes all 18 docs in docs/ - [ ] All table links resolve to existing files ### Test Expectations - [ ] `readlink CLAUDE.md` returns `README.md` - [ ] All relative links in the table point to existing files - Run command: `find docs -name "*.md" | wc -l` matches table row count ### Constraints - CLAUDE.md must be a symlink, not a copy - README remains the single source of truth ### Checklist - [ ] PR opened - [ ] Tests pass - [ ] No unrelated changes ### Related - `landscaping-assistant` -- project this affects