Skip to content

Commit f014ea5

Browse files
cameroncookecameroncooke
committed
docs: Reorganize technical documentation into docs/ directory
STRUCTURAL CHANGES: - Created docs/ directory for better organization - Moved 8 technical documentation files to docs/: * ARCHITECTURE.md * CHANGELOG.md * CLAUDE.md * CODE_OF_CONDUCT.md * CONTRIBUTING.md * TESTING.md * TOOL_OPTIONS.md * TOOLS.md REFERENCE UPDATES: - Updated all file references in README.md to point to docs/ directory - Updated @docs/TESTING.md reference in CLAUDE.md - Updated TESTING.md references in src/utils/command.ts - Updated release script to reference docs/TOOL_OPTIONS.md BENEFITS: ✅ Cleaner root directory structure ✅ Better separation of code and documentation ✅ Follows standard project organization practices ✅ Maintains all existing functionality and references All documentation remains fully accessible with updated paths.
1 parent a4eae57 commit f014ea5

File tree

11 files changed

+11
-11
lines changed

11 files changed

+11
-11
lines changed

‎README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ Cursor:
254254
find ~/Library/Application\ Support/Cursor/logs -name "Cursor MCP.log" -exec zip -r matching_logs.zip {} +
255255
```
256256

257-
If your MCP client doesn't have log files you can run the server directly using the MCP Inspector tool see [Debugging](CONTRIBUTING.md#debugging) for more information on how to do this. Once running the MCP tool prints all log messages to it's error pane, which can be helpful in diagnosing issues.
257+
If your MCP client doesn't have log files you can run the server directly using the MCP Inspector tool see [Debugging](docs/CONTRIBUTING.md#debugging) for more information on how to do this. Once running the MCP tool prints all log messages to it's error pane, which can be helpful in diagnosing issues.
258258

259259
## Privacy
260260

@@ -331,7 +331,7 @@ XcodeBuildMCP follows a modular, layered architecture designed for extensibility
331331
- **Pattern**: Import production code, mock only external dependencies
332332
- **Validation**: Deterministic response validation for all tools
333333

334-
For detailed architectural documentation, see [ARCHITECTURE.md](ARCHITECTURE.md).
334+
For detailed architectural documentation, see [ARCHITECTURE.md](docs/ARCHITECTURE.md).
335335

336336
## Selective tool registration
337337

@@ -374,20 +374,20 @@ https://github.com/user-attachments/assets/e3c08d75-8be6-4857-b4d0-9350b26ef086
374374

375375
XcodeBuildMCP includes comprehensive documentation to help you understand and extend the project:
376376

377-
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Detailed architectural overview, design principles, and component details
378-
- **[TOOLS.md](TOOLS.md)** - Complete documentation of all 81 available tools
377+
- **[ARCHITECTURE.md](docs/ARCHITECTURE.md)** - Detailed architectural overview, design principles, and component details
378+
- **[TOOLS.md](docs/TOOLS.md)** - Complete documentation of all 81 available tools
379379
- **[TOOL_OPTIONS.md](TOOL_OPTIONS.md)** - Tool configuration and selective enablement guide
380-
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Development setup, testing standards, and contribution guidelines
380+
- **[CONTRIBUTING.md](docs/CONTRIBUTING.md)** - Development setup, testing standards, and contribution guidelines
381381
- **[CHANGELOG.md](CHANGELOG.md)** - Version history and release notes
382382

383383
For AI assistants and automated tools:
384-
- **[CLAUDE.md](CLAUDE.md)** - Guidelines for AI assistants working with this codebase
384+
- **[CLAUDE.md](docs/CLAUDE.md)** - Guidelines for AI assistants working with this codebase
385385

386386
## Contributing
387387

388388
Contributions are welcome! Here's how you can help improve XcodeBuildMCP.
389389

390-
See our [CONTRIBUTING](CONTRIBUTING.md) document for detailed contribution guidelines, including:
390+
See our [CONTRIBUTING](docs/CONTRIBUTING.md) document for detailed contribution guidelines, including:
391391
- Development setup instructions
392392
- Mandatory testing principles
393393
- Code quality standards

ARCHITECTURE.md renamed to docs/ARCHITECTURE.md

File renamed without changes.

CHANGELOG.md renamed to docs/CHANGELOG.md

File renamed without changes.

CLAUDE.md renamed to docs/CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document provides an overview of the `xcodebuildmcp` project architecture f
44

55
## 📋 Quick Reference
66

7-
**IMPORTANT**: Before working with tests, read the comprehensive @TESTING.md which covers:
7+
**IMPORTANT**: Before working with tests, read the comprehensive @docs/TESTING.md which covers:
88
- Integration testing philosophy
99
- Three-dimensional testing strategy (Input validation, Command generation, Output processing)
1010
- Mock strategies and patterns

CODE_OF_CONDUCT.md renamed to docs/CODE_OF_CONDUCT.md

File renamed without changes.

CONTRIBUTING.md renamed to docs/CONTRIBUTING.md

File renamed without changes.

TESTING.md renamed to docs/TESTING.md

File renamed without changes.

TOOLS.md renamed to docs/TOOLS.md

File renamed without changes.

TOOL_OPTIONS.md renamed to docs/TOOL_OPTIONS.md

File renamed without changes.

‎scripts/release.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ run "sed -i '' -E 's/npm%3Axcodebuildmcp%40[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9]+\
7979

8080
echo ""
8181
echo "📝 Updating version in TOOL_OPTIONS.md..."
82-
run "sed -i '' -E 's/@[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9]+\.[0-9]+)?(-[a-zA-Z0-9]+\.[0-9]+)*(-[a-zA-Z0-9]+)?/@'"$VERSION"'/g' TOOL_OPTIONS.md"
82+
run "sed -i '' -E 's/@[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9]+\.[0-9]+)?(-[a-zA-Z0-9]+\.[0-9]+)*(-[a-zA-Z0-9]+)?/@'"$VERSION"'/g' docs/TOOL_OPTIONS.md"
8383

8484
# Git operations
8585
echo ""

0 commit comments

Comments
 (0)