Skip to content

Conversation

@okotaku
Copy link
Owner

@okotaku okotaku commented Jul 7, 2025

Summary

  • Consolidate all documentation from docs/ directory into root-level README.md and CLAUDE.md
  • Remove documentation build infrastructure and dependencies
  • Simplify project structure by eliminating separate documentation builds

Changes Made

📁 Documentation Consolidation

  • README.md: Enhanced with comprehensive project documentation, installation guides, and usage examples
  • CLAUDE.md: Expanded with complete AI development workflows and Claude Code setup guide
  • CHANGELOG.md: Moved from docs/changelog.md to project root for easy access

🗑️ Removed Documentation Infrastructure

  • Configuration Files: Deleted .readthedocs.yaml
  • GitHub Actions: Removed docs.yml and reusable-docs-build.yml workflows
  • Dependencies: Removed all Sphinx and documentation-related dependencies from pyproject.toml
  • Docker: Removed template-docs service from docker-compose.yml
  • Directory: Completely removed docs/ directory and all contents

🔧 Updated References

  • Updated GitHub Actions workflows to remove documentation jobs
  • Updated workflow descriptions to remove docs references
  • Clean uv.lock file without unused documentation dependencies
  • Updated project structure documentation to reflect changes

Benefits

Simplified Structure: No more separate documentation builds or complex setup
Faster Setup: Reduced dependencies and faster installation
Easy Access: All documentation at project root level
Maintained Content: All valuable documentation content preserved and enhanced
AI-First Focus: Enhanced CLAUDE.md with comprehensive AI development workflows

Test Plan

  • Verify all essential documentation content is preserved
  • Confirm GitHub Actions workflows pass without docs jobs
  • Test clean dependency installation with uv sync --all-extras
  • Validate markdown formatting and linting
  • Ensure project structure is clean and accessible

🤖 Generated with Claude Code

- Add language tags to code blocks
- Convert bold text to proper headings for better structure

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@okotaku okotaku merged commit 050c745 into main Jul 7, 2025
10 checks passed
@okotaku okotaku deleted the feat/modernize-template branch July 7, 2025 22:59
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