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.

Sign up for GitHub

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

Jump to bottom
Open
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
Open

docs: add comprehensive development documentation #18646

wants to merge 1 commit into from
+1,272 −479

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.

This was referenced Jun 27, 2025
Open
Merged
This was referenced Jun 27, 2025
Open
Merged
Open
@ThomasK33 Graphite App
Copy link
Member Author

ThomasK33 commented Jun 27, 2025 •
edited
Loading

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Jun 27, 2025
Open
Open
@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-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from 4e18b08 to 58b076d Compare June 30, 2025 16:42
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 7a348cb to eb5615f Compare June 30, 2025 16:42
This was referenced Jun 30, 2025
Open
Open
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from 58b076d to 88f01e4 Compare June 30, 2025 16:45
@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 5b9f0b2 to a320c08 Compare June 30, 2025 17:56
@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 0d042a4 to f4614fd Compare July 1, 2025 09:15
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from a320c08 to 3417103 Compare July 1, 2025 09:15
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from f4614fd to 5943be1 Compare July 1, 2025 09:27
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 3417103 to 66f2908 Compare July 1, 2025 09:27
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from 5943be1 to 2e85437 Compare July 1, 2025 13:23
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 66f2908 to 4a0ebd7 Compare July 1, 2025 13:23
@ThomasK33 ThomasK33 mentioned this pull request Jul 1, 2025
Open
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 4a0ebd7 to 2f305f7 Compare July 1, 2025 13:42
@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 aa379a5 to 639a685 Compare July 1, 2025 16:50
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 2f305f7 to 33190fa Compare July 1, 2025 16:50
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from 639a685 to 64f711e Compare July 1, 2025 16:56
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 33190fa to 0b75800 Compare July 1, 2025 16:56
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from 64f711e to b7b1e7c Compare July 1, 2025 17:04
@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 decfff1 to d40ab47 Compare July 1, 2025 17:18
@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 468aa1b to f44cb3a Compare July 1, 2025 19:54
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from d40ab47 to ac3723a Compare July 1, 2025 19:54
@ThomasK33
docs: refactor CLAUDE.md to use import system and comprehensive workf…
c0cfb5b 
…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 <[email protected]>
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from ac3723a to d596e33 Compare July 1, 2025 20:14
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from f44cb3a to c0cfb5b Compare July 1, 2025 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johnstcn johnstcn johnstcn approved these changes

@ibetitsmike ibetitsmike ibetitsmike approved these changes

Assignees

@ThomasK33 ThomasK33

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ThomasK33 @johnstcn @ibetitsmike