Skip to content

Commit cf9d455

Browse files
jonphippsclaude
andcommitted
docs: update CLAUDE.md with current scaffold template system
- Add Site Scaffolding Commands section with current command syntax - Update Site Config Generation to reflect template files and structure - Expand Scaffolding and Templates section with comprehensive details - Document CompactButton component and tabbed overview pages - Reference current developer documentation for complete system details - Include template structure and Nx integration information CLAUDE.md now accurately reflects the current state of the scaffolding system with complete template structure and professional site generation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 492b175 commit cf9d455

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

CLAUDE.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
1313
- **Type checking**: `pnpm typecheck` (nx affected with parallel execution)
1414
- **Linting**: `pnpm lint` (nx affected with parallel execution)
1515

16+
### Site Scaffolding Commands
17+
- **Create new site**: `pnpm tsx scripts/scaffold-site.ts --siteKey=newsite --title="New Standard" --tagline="A new IFLA standard"`
18+
- **Template location**: Complete site template in `scripts/scaffold-template/` with ISBD-matching structure
19+
- **Generated files**: `docusaurus.config.ts`, `project.json`, all content pages, and CompactButton component
20+
- **Features**: Tabbed overview pages, comprehensive documentation structure, Nx integration
21+
- **Documentation**: See `developer_notes/current-scaffolding-plan.md` for complete system details
22+
1623
### Testing Commands
1724

1825
#### NX Testing Commands
@@ -159,8 +166,10 @@ standards-dev/
159166
### Key Configuration Patterns
160167

161168
#### Site Config Generation
162-
- **Template system**: `scripts/site-template.ts` generates complete site configurations
163-
- **Individual configs**: Each site has a `site-config.json` defining its unique properties
169+
- **Template system**: `scripts/site-template.ts` and complete scaffold template in `scripts/scaffold-template/`
170+
- **Individual configs**: Generated from template files with placeholder replacement
171+
- **Rich content structure**: Tabbed overview pages, comprehensive documentation, CompactButton components
172+
- **Configuration templates**: `docusaurus.config.ts.template` and `project.json.template` for dynamic generation
164173
- **Feature flags**: Support for custom sidebars, element redirects, RDF downloads, etc.
165174

166175
#### Environment and Navigation
@@ -179,9 +188,15 @@ standards-dev/
179188

180189
### Scaffolding and Templates
181190
- **CRITICAL**: Always check and update scaffolding templates when making configuration changes that affect all sites
182-
- **Template locations**: `scripts/site-template.ts` and `scripts/scaffold-site.ts`
191+
- **Template system**: Complete site template in `scripts/scaffold-template/` with rich content structure
192+
- **Template files**: `docusaurus.config.ts.template`, `project.json.template`, and complete directory structure
193+
- **Key components**: CompactButton component, tabbed overview pages, comprehensive documentation structure
194+
- **Scaffolding script**: `scripts/scaffold-site.ts` generates new sites from template with placeholder replacement
195+
- **Template structure**: Matches ISBD pattern with Element Sets, Value Vocabularies, and Documentation tabs
183196
- **Pattern**: When fixing issues in existing sites, verify the scaffold template doesn't propagate the same issue to future sites
197+
- **Component consistency**: Template includes reusable CompactButton and navigation patterns
184198
- **Example**: If removing test targets from existing sites, also remove from site template
199+
- **Documentation**: See `developer_notes/current-scaffolding-plan.md` for complete system documentation
185200

186201
## Test Placement Decision Tree (CRITICAL - Reference When Creating Tests)
187202

0 commit comments

Comments
 (0)