Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ jobs:
run: |
# Verify patterns documentation exists
test -d docs/patterns || { echo "Error: docs/patterns/ missing"; exit 1; }
test -f docs/quickstart.md || { echo "Error: docs/quickstart.md missing"; exit 1; }
test -f docs/index.md || { echo "Error: docs/index.md missing"; exit 1; }
test -f docs/README.md || { echo "Error: docs/README.md missing"; exit 1; }
test -d docs/adr || { echo "Error: docs/adr/ missing"; exit 1; }
echo "All required documentation files present"
45 changes: 32 additions & 13 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,9 @@ This is a **GitHub template repository** demonstrating AI-assisted development b

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

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

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

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

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

- Documentation validation workflows
- Markdown linting
- Mermaid diagram validation
- Codebase Agent automation (codebase-agent.yml)
- Documentation validation (docs-validation.yml)
- Security scanning (security.yml)
- Documentation deployment (deploy-docs.yml)

**Automation Scripts** (`.github/scripts/codebase_agent/`):

- Python module for CBA workflow execution
- AI client with Vertex AI and Anthropic API support
- GitHub event parsing and PR automation

### Working Application Demo

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

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

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

### Mermaid Diagrams (CRITICAL)

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

**Workflows**:

1. **`.github/workflows/docs-validation.yml`** (Documentation)
1. **`.github/workflows/codebase-agent.yml`** (Codebase Agent)
- Issue-to-PR automation
- PR review automation
- Triggered by: @cba mentions, cba-review/cba-help labels
- Supports both Anthropic API and Vertex AI authentication

2. **`.github/workflows/docs-validation.yml`** (Documentation)
- Markdown linting (markdownlint)
- Mermaid diagram validation
- Link checking
- Triggers: on docs/** changes, PRs

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

4. **`.github/workflows/deploy-docs.yml`** (Documentation Deployment)
- Deploys documentation to GitHub Pages
- Triggers: on main branch push

5. **`.github/workflows/security.yml`** (Security Scanning)
- Security vulnerability scanning
- Triggers: on push, PR, schedule

### Dependabot

**File**: `.github/dependabot.yml`
Expand Down
2 changes: 1 addition & 1 deletion PRESENTATION-ambient-code-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -638,7 +638,7 @@ cd reference
# Explore the patterns
cat .claude/agents/codebase-agent.md
cat .claude/context/architecture.md
cat docs/quickstart.md
cat docs/README.md

# Copy to your project
#commented out on purpose cp -r .claude /path/to/your/project/
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ AI-assisted development patterns. Each pattern is standalone - adopt what you ne

## Getting Started

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

## Development Setup

Expand All @@ -40,7 +40,7 @@ npm install -g markdownlint-cli @mermaid-js/mermaid-cli
```text
reference/
├── docs/
│ ├── quickstart.md # Pattern overview and adoption path
│ ├── README.md # Quickstart guide
│ └── patterns/ # Individual pattern docs
├── .claude/ # Example CBA configuration
├── PRESENTATION-ambient-code-reference.md # 9-feature overview
Expand Down
File renamed without changes.
40 changes: 0 additions & 40 deletions docs/index.md

This file was deleted.