Skip to content

docs: extract installation details from CLAUDE.md and reduce duplication#29

Merged
docer1990 merged 1 commit into
mainfrom
docs/refactor-documentation
Mar 24, 2026
Merged

docs: extract installation details from CLAUDE.md and reduce duplication#29
docer1990 merged 1 commit into
mainfrom
docs/refactor-documentation

Conversation

@docer1990

Copy link
Copy Markdown
Owner

Summary

  • Refactored CLAUDE.md from 453 → 165 lines (64% reduction)
  • Extracted installation, release workflow, launcher script, and
    prerequisites into docs/installation.md
  • Removed duplicated JSON-RPC method tables (were listed in both
    Architecture Overview and MCP Tools sections)
  • Removed instrumentation/iOS pattern deep dives already covered in
    LEARNING.md
  • Removed file listings, default config values, and unit test
    tables derivable from the codebase
  • Consolidated Android/iOS automation workflows into a single
    unified section
  • Added "Further Reading" section linking to LEARNING.md,
    docs/installation.md, and kotlin-mcp-server.instruction.md

Motivation

CLAUDE.md is loaded into every Claude Code conversation. Keeping
it focused on actionable coding guidance (build commands, tool
references, key patterns) reduces context window usage while
preserving all information Claude needs to work with the codebase.

Copilot AI review requested due to automatic review settings March 24, 2026 12:32

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Refactors developer-facing documentation to keep CLAUDE.md concise (for Claude Code context efficiency) by moving detailed installation/release/launcher content into docs/installation.md, while also adding OpenSpec documentation for a ToolFactory refactor (ToolScope DSL + ToolDiscovery extraction).

Changes:

  • Extracted “Installation & Distribution” guidance into docs/installation.md and trimmed CLAUDE.md accordingly.
  • Simplified CLAUDE.md architecture + workflow sections and removed duplicated deep dives already covered elsewhere.
  • Added new OpenSpec specs + an archived change proposal/design/tasks for the ToolFactory refactor.

Reviewed changes

Copilot reviewed 4 out of 10 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
docs/installation.md New consolidated installation/distribution documentation extracted from CLAUDE.md.
CLAUDE.md Reduced size by removing detailed installation/release and deep-dive sections; added links to “Further Reading”.
openspec/specs/tool-registration-dsl/spec.md New spec describing ToolScope/registrar approach (has a few inconsistencies vs current code).
openspec/specs/tool-discovery/spec.md New spec describing extracted ToolDiscovery behavior.
openspec/changes/archive/2026-03-24-refactor-toolfactory/.openspec.yaml Metadata for archived OpenSpec change set.
openspec/changes/archive/2026-03-24-refactor-toolfactory/proposal.md Archived proposal for ToolFactory refactor.
openspec/changes/archive/2026-03-24-refactor-toolfactory/design.md Archived design notes for ToolFactory refactor (some counts don’t match code).
openspec/changes/archive/2026-03-24-refactor-toolfactory/tasks.md Archived task checklist (mentions runBlocking though implementation doesn’t).
openspec/changes/archive/2026-03-24-refactor-toolfactory/specs/tool-registration-dsl/spec.md Archived copy of the ToolScope/registrar spec (same inconsistencies as the main spec).
openspec/changes/archive/2026-03-24-refactor-toolfactory/specs/tool-discovery/spec.md Archived copy of the ToolDiscovery spec.

Comment thread openspec/specs/tool-registration-dsl/spec.md
Comment thread openspec/specs/tool-registration-dsl/spec.md
Comment thread openspec/specs/tool-registration-dsl/spec.md
Comment thread openspec/specs/tool-registration-dsl/spec.md
Comment thread openspec/specs/tool-registration-dsl/spec.md
@docer1990 docer1990 merged commit 161ac0c into main Mar 24, 2026
7 checks passed
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