Skip to content

Add CLAUDE.md documentation for site structure and workflow - #6

Merged
steveya merged 1 commit into
masterfrom
claude/add-claude-documentation-mM4KL
Mar 16, 2026
Merged

steveya merged 1 commit into
masterfrom
claude/add-claude-documentation-mM4KL

Conversation

@steveya

@steveya steveya commented Mar 15, 2026

Copy link
Copy Markdown
Owner

Summary

This PR adds comprehensive documentation for the Quarto-based static website project. The new CLAUDE.md file serves as a reference guide for understanding the project structure, build process, and content creation workflows.

Key changes

  • Added CLAUDE.md — A detailed project guide covering:
    • Project overview (Quarto 1.5+, GitHub Pages deployment, static code blocks)
    • Complete repository structure with directory descriptions
    • Common build and preview commands
    • CI/CD pipeline details (GitHub Actions, Playwright E2E tests)
    • Post creation workflow including the "stealth notebook" pattern for private drafting
    • Index generation process for series, notes, projects, and categories
    • Citation and bibliography management via BibTeX
    • Styling conventions (custom CSS, color palette, plot styles)
    • Strict writing and prose requirements (tone, structure, math notation, derivations)
    • Key naming conventions and deployment details

Implementation details

The documentation captures the current state of the project including:

  • Build pipeline with pre-render hooks that auto-generate index pages
  • Quarto configuration with disabled code execution
  • GitHub Pages deployment from the docs/ directory
  • Playwright-based smoke testing for search and bibliography rendering
  • Custom Python utilities for post scaffolding and notebook preview
  • Shared bibliography system via posts/_metadata.yml
  • Strict editorial guidelines for academic writing standards

This guide is intended to help contributors and maintainers understand the project architecture and follow established conventions.

https://claude.ai/code/session_01Rmv69DpeqNmht9UqpwsqvC

Covers project structure, build/test workflows, post creation,
writing conventions, styling, and CI/CD for AI assistant context.

https://claude.ai/code/session_01Rmv69DpeqNmht9UqpwsqvC
@steveya
steveya merged commit 1148fca into master Mar 16, 2026
1 check passed
@steveya
steveya deleted the claude/add-claude-documentation-mM4KL branch March 16, 2026 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants