Skip to content

docs: add comprehensive development documentation #18646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance
Choose a base branch
from

Conversation

ThomasK33
Copy link
Member

Organize Development Documentation into Separate Files

This PR reorganizes the development documentation by splitting the monolithic CLAUDE.md file into multiple focused documents. The main file now provides a concise overview with essential commands and critical patterns, while importing detailed content from specialized guides.

Key improvements:

  • Created separate documentation files for specific domains:
    • Database development patterns
    • OAuth2 implementation guidelines
    • Testing best practices
    • Troubleshooting common issues
    • Development workflows and guidelines
  • Restructured the main CLAUDE.md to be more scannable with improved formatting
  • Added quick-reference tables for common commands
  • Maintained all existing content while making it more accessible
  • Highlighted critical patterns that must be followed

This organization makes the documentation more maintainable and easier to navigate, allowing developers to quickly find relevant information for their specific tasks.

@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 3902793 to b37d850 Compare June 27, 2025 17:02
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from fd603bc to d26af81 Compare June 27, 2025 17:02
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from b37d850 to caf974c Compare June 27, 2025 17:11
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch 2 times, most recently from 518f971 to 6879177 Compare June 27, 2025 17:29
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from caf974c to 22b8b6d Compare June 27, 2025 17:29
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from 6879177 to 82503dd Compare June 27, 2025 17:29
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch 2 times, most recently from 14c7196 to c43b551 Compare June 27, 2025 17:54
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch 2 times, most recently from bfef58f to 75fd8b1 Compare June 28, 2025 10:32
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 5bd96e8 to 840e8ad Compare June 28, 2025 10:48
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from 75fd8b1 to 46523ec Compare June 28, 2025 10:48
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 840e8ad to 0cb8739 Compare June 28, 2025 18:18
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from 46523ec to 9002beb Compare June 28, 2025 18:18
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 0cb8739 to 4dd6127 Compare June 28, 2025 18:59
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch 2 times, most recently from 6bcd32e to e81c2f9 Compare June 29, 2025 11:04
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 4dd6127 to 624d8b6 Compare June 29, 2025 11:04
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from e81c2f9 to e807fde Compare June 29, 2025 11:17
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 624d8b6 to 51c5fc8 Compare June 29, 2025 11:17
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 51c5fc8 to da04da3 Compare June 29, 2025 11:23
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from e807fde to d45589a Compare June 29, 2025 11:23
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from da04da3 to 1ac699e Compare June 29, 2025 18:30
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from d45589a to dfa2dcc Compare June 29, 2025 18:30
…lows

- Restructure CLAUDE.md to use @import syntax for better organization
- Create comprehensive WORKFLOWS.md with all development procedures
- Add detailed documentation for OAuth2, Testing, Database, and Troubleshooting
- Organize all Claude Code documentation in .claude/docs/ directory
- Maintain lean main file while preserving all essential context
- Include missing development server setup and migration workflows

Change-Id: I641f46c0b0da384f7bbdf8b58374ecfa1572b594
Signed-off-by: Thomas Kosiewski <tk@coder.com>
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from dfa2dcc to 55ff368 Compare June 29, 2025 20:16
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 1ac699e to 1b1df11 Compare June 29, 2025 20:16
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