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
Merged
merged 1 commit into from
Jul 3, 2025
Merged

docs: add comprehensive development documentation #18646

merged 1 commit into from
Jul 3, 2025

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
Merged
Merged
This was referenced Jun 27, 2025
Merged
Merged
Merged
@ThomasK33 Graphite App
Copy link
Member Author

ThomasK33 commented Jun 27, 2025 •
edited
Loading

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

This was referenced Jun 27, 2025
Merged
Merged
@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 6b97ceb to 4920f70 Compare July 2, 2025 12:44
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 16c7b15 to a8a29d4 Compare July 2, 2025 13:58
@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 b7601e7 to ce40271 Compare July 2, 2025 14:06
@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 f9e693d to 9629df1 Compare July 2, 2025 15:51
@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 4095815 to df954c4 Compare July 2, 2025 16:35
@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 df790c7 to 17af791 Compare July 2, 2025 16:45
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from df954c4 to 2168bf9 Compare July 2, 2025 16:45
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from 17af791 to 3e15358 Compare July 2, 2025 16:59
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from 2168bf9 to 9d2fe4d Compare July 2, 2025 17:00
@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 6bea7a6 to e33d3d6 Compare July 2, 2025 17:15
@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 95ea96c to c667cbf Compare July 3, 2025 15:00
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance branch from e33d3d6 to 4f4e4f1 Compare July 3, 2025 15:00
This was referenced Jul 3, 2025
Merged
Merged
@ThomasK33 ThomasK33 changed the base branch from thomask33/06-27-feat_oauth2_implement_rfc_7591_7592_dynamic_client_registration_for_mcp_compliance to graphite-base/18646 July 3, 2025 16:33
@ThomasK33 ThomasK33 force-pushed the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from c667cbf to dca4260 Compare July 3, 2025 16:34
@ThomasK33 ThomasK33 force-pushed the graphite-base/18646 branch from 4f4e4f1 to 74e1d5c Compare July 3, 2025 16:34
@graphite-app graphite-app bot changed the base branch from graphite-base/18646 to main July 3, 2025 16:34
@ThomasK33
docs: refactor CLAUDE.md to use import system and comprehensive workf…
3813249 
…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-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch from dca4260 to 3813249 Compare July 3, 2025 16:34
@ThomasK33 ThomasK33 merged commit 4dcf0c3 into main Jul 3, 2025
36 checks passed
@ThomasK33 Graphite App
Copy link
Member Author

Merge activity

@ThomasK33 ThomasK33 deleted the thomask33/06-27-docs_refactor_claude.md_to_use_import_system_and_comprehensive_workflows branch July 3, 2025 16:51
@github-actions github-actions bot locked and limited conversation to collaborators Jul 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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