Skip to content

docs: populate project documentation with codebase-specific content#15

Merged
amiller68 merged 6 commits intomainfrom
docs/populate-project-documentation
Feb 18, 2026
Merged

docs: populate project documentation with codebase-specific content#15
amiller68 merged 6 commits intomainfrom
docs/populate-project-documentation

Conversation

@amiller68
Copy link
Owner

Summary

Audit the codebase and populate all skeleton documentation files with project-specific content.

  • CLAUDE.md: Project description, quick reference commands, structure overview, constraints
  • docs/index.md: Quick start commands, development URLs, agent guidelines
  • docs/PATTERNS.md: Python/TypeScript error handling, module organization, naming conventions
  • docs/SUCCESS_CRITERIA.md: Actual CI check commands for both workspaces
  • docs/PROJECT_LAYOUT.md: Full directory structure with descriptions
  • docs/CONTRIBUTING.md: Setup instructions, Conventional Commits format
  • .claude/settings.json: Restore and expand Claude Code permissions
  • .claude/skills/: Update check and review skills for this project
  • py/docs/PYTHON_LIBRARY_PATTERNS.md: Add SQLAlchemy patterns (StringEnum ORM vs Core gotcha, uuid7)
  • py/docs/TASKS.md: New comprehensive TaskIQ background jobs guide

Test plan

  • Documentation accurately reflects actual commands (make check, make dev, etc.)
  • Claude Code permissions allow expected operations
  • Skills invoke correct project-specific commands

🤖 Generated with Claude Code

amiller68 and others added 5 commits February 17, 2026 16:41
- CLAUDE.md: Add project description, commands, structure, constraints
- docs/index.md: Add quick start commands and agent guidelines
- docs/PATTERNS.md: Document Python/TypeScript conventions
- docs/SUCCESS_CRITERIA.md: Add actual CI check commands
- docs/PROJECT_LAYOUT.md: Document full directory structure
- docs/CONTRIBUTING.md: Add setup and commit conventions
- .claude/skills/: Update check and review skills for this project
- issues/: Add README and template for file-based tracking
- jig.toml: Add Claude Code configuration

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Restore the comprehensive permission settings that were accidentally
reduced. Added additional permissions for:
- All make targets including db, setup, teardown, worktree
- Docker inspection commands (ps, logs, images)
- Additional git commands (fetch, remote, rev-parse)
- Shell utilities (sort, uniq, tr, cut, xargs, etc.)
- jig and bin scripts
- tmux session inspection

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- PYTHON_LIBRARY_PATTERNS.md: Add SQLAlchemy Patterns section
  - StringEnum ORM vs Core gotcha (critical: use .value in Core ops)
  - uuid7 time-sortable IDs pattern
  - utcnow() for consistent timestamps

- TASKS.md: New comprehensive TaskIQ background jobs guide
  - @Cron decorator with distributed locking
  - Task dependencies (TaskiqDepends)
  - Run tracking and observability
  - Worker/scheduler setup
  - Best practices and troubleshooting

- README.md: Add TASKS.md to document index
- docs/PATTERNS.md: Cross-reference to detailed Python docs

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add db-* commands to Makefiles that were documented but missing:
- db-up, db-down, db-status, db-endpoint, db-connect
- db-migrate, db-prepare

Also fix docs/CONTRIBUTING.md to use correct command syntax.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
New skill covering:
- Model creation and modification workflow
- Migration generation (auto and manual)
- Common scenarios (add column, rename, data migration)
- Troubleshooting and best practices

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@amiller68 amiller68 marked this pull request as ready for review February 18, 2026 03:10
@amiller68 amiller68 merged commit 2abaafd into main Feb 18, 2026
11 checks passed
@amiller68 amiller68 deleted the docs/populate-project-documentation branch February 18, 2026 03:15
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.

1 participant