Skip to content

Commit 2ac786c

Browse files
jeremyederclaude
andauthored
docs: update documentation structure and workflow references (#18)
* docs: update documentation structure and workflow references Reorganize documentation to reflect current repository state: - Move docs/quickstart.md to docs/README.md for better discoverability - Delete redundant docs/index.md - Update CLAUDE.md with accurate repository structure - Document new codebase-agent.yml workflow and automation scripts - Update all cross-references to new doc paths in README and PRESENTATION Changes to CLAUDE.md: - Add .github/scripts/codebase_agent/ automation module - Document all 5 GitHub Actions workflows (was 2) - Update docs/ structure to reflect standalone patterns approach - Remove references to deleted architecture.md, tutorial.md, api-reference.md Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fix: update CI to check for new documentation structure Update ci.yml to check for docs/README.md instead of docs/quickstart.md and remove check for deleted docs/index.md. Add check for docs/adr/. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent ec34ddc commit 2ac786c

6 files changed

Lines changed: 37 additions & 58 deletions

File tree

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ jobs:
1818
run: |
1919
# Verify patterns documentation exists
2020
test -d docs/patterns || { echo "Error: docs/patterns/ missing"; exit 1; }
21-
test -f docs/quickstart.md || { echo "Error: docs/quickstart.md missing"; exit 1; }
22-
test -f docs/index.md || { echo "Error: docs/index.md missing"; exit 1; }
21+
test -f docs/README.md || { echo "Error: docs/README.md missing"; exit 1; }
22+
test -d docs/adr || { echo "Error: docs/adr/ missing"; exit 1; }
2323
echo "All required documentation files present"

CLAUDE.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,9 @@ This is a **GitHub template repository** demonstrating AI-assisted development b
3636

3737
**Documentation** (`docs/`):
3838

39-
- Quickstart guides for AI-assisted development
40-
- Architecture pattern references
41-
- Tutorial outlines for implementing agentic workflows
42-
- API design patterns
39+
- Quickstart guide (README.md) for AI-assisted development
40+
- Standalone pattern documentation (patterns/)
41+
- ADR scaffolding (adr/)
4342

4443
**Codebase Agent Configuration** (`.claude/`):
4544

@@ -49,9 +48,16 @@ This is a **GitHub template repository** demonstrating AI-assisted development b
4948

5049
**CI/CD** (`.github/workflows/`):
5150

52-
- Documentation validation workflows
53-
- Markdown linting
54-
- Mermaid diagram validation
51+
- Codebase Agent automation (codebase-agent.yml)
52+
- Documentation validation (docs-validation.yml)
53+
- Security scanning (security.yml)
54+
- Documentation deployment (deploy-docs.yml)
55+
56+
**Automation Scripts** (`.github/scripts/codebase_agent/`):
57+
58+
- Python module for CBA workflow execution
59+
- AI client with Vertex AI and Anthropic API support
60+
- GitHub event parsing and PR automation
5561

5662
### Working Application Demo
5763

@@ -131,10 +137,9 @@ markdownlint docs/**/*.md README.md CLAUDE.md --fix
131137

132138
**Core docs** (`docs/`):
133139

134-
1. `quickstart.md` - 5-minute introduction to AI-assisted development
135-
2. `architecture.md` - Common architecture patterns for agentic workflows
136-
3. `tutorial.md` - Step-by-step guide for implementing patterns
137-
4. `api-reference.md` - API design patterns for AI-assisted apps
140+
1. `README.md` - 5-minute quickstart for AI-assisted development patterns
141+
2. `patterns/` - Individual pattern documentation (standalone, independently adoptable)
142+
3. `adr/` - Architecture Decision Records scaffolding (template only)
138143

139144
### Mermaid Diagrams (CRITICAL)
140145

@@ -276,17 +281,31 @@ Focus on "why" rather than "what".
276281

277282
**Workflows**:
278283

279-
1. **`.github/workflows/docs-validation.yml`** (Documentation)
284+
1. **`.github/workflows/codebase-agent.yml`** (Codebase Agent)
285+
- Issue-to-PR automation
286+
- PR review automation
287+
- Triggered by: @cba mentions, cba-review/cba-help labels
288+
- Supports both Anthropic API and Vertex AI authentication
289+
290+
2. **`.github/workflows/docs-validation.yml`** (Documentation)
280291
- Markdown linting (markdownlint)
281292
- Mermaid diagram validation
282293
- Link checking
283294
- Triggers: on docs/** changes, PRs
284295

285-
2. **`.github/workflows/ci.yml`** (General CI)
296+
3. **`.github/workflows/ci.yml`** (General CI)
286297
- Code example linting (if any)
287298
- Documentation build test
288299
- Triggers: on push, PR
289300

301+
4. **`.github/workflows/deploy-docs.yml`** (Documentation Deployment)
302+
- Deploys documentation to GitHub Pages
303+
- Triggers: on main branch push
304+
305+
5. **`.github/workflows/security.yml`** (Security Scanning)
306+
- Security vulnerability scanning
307+
- Triggers: on push, PR, schedule
308+
290309
### Dependabot
291310

292311
**File**: `.github/dependabot.yml`

PRESENTATION-ambient-code-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -638,7 +638,7 @@ cd reference
638638
# Explore the patterns
639639
cat .claude/agents/codebase-agent.md
640640
cat .claude/context/architecture.md
641-
cat docs/quickstart.md
641+
cat docs/README.md
642642

643643
# Copy to your project
644644
#commented out on purpose cp -r .claude /path/to/your/project/

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ AI-assisted development patterns. Each pattern is standalone - adopt what you ne
1717

1818
## Getting Started
1919

20-
See [Quickstart](docs/quickstart.md) for pattern overview and adoption guidance.
20+
See [Quickstart](docs/README.md) for pattern overview and adoption guidance.
2121

2222
## Development Setup
2323

@@ -40,7 +40,7 @@ npm install -g markdownlint-cli @mermaid-js/mermaid-cli
4040
```text
4141
reference/
4242
├── docs/
43-
│ ├── quickstart.md # Pattern overview and adoption path
43+
│ ├── README.md # Quickstart guide
4444
│ └── patterns/ # Individual pattern docs
4545
├── .claude/ # Example CBA configuration
4646
├── PRESENTATION-ambient-code-reference.md # 9-feature overview
File renamed without changes.

docs/index.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

0 commit comments

Comments
 (0)