Skip to content

Commit 79086a0

Browse files
author
LittleCoinCoin
committed
docs: update cross-references following corrected alignment strategy
Implement cross-reference architecture v2 recommendations: Tutorial 03 Checkpoint Updates: - Add natural progression link to Tutorial 04 MCP Host Configuration - Emphasize package deployment as next logical step after authoring - Maintain clear learning path from development to deployment GettingStarted.md Updates: - Replace non-existent CI Automation tutorial with MCP Host Configuration - Update learning path to reflect actual available tutorial series - Ensure accurate tutorial progression guidance MCPHostConfiguration.md Updates: - Fix broken cross-reference to deleted MCP/synchronization_commands.md - Add comprehensive hands-on learning section with tutorial links - Implement corrected cross-reference alignment: * Tutorial 04-04 (Environment Sync) links to MCPHostConfiguration.md * Tutorial 04-05 (Advanced Sync) links to MCPHostConfiguration.md - Provide clear navigation between reference docs and tutorials Follows cross-reference architecture v2 specifications: - Corrected tutorial progression with proper linking sequence - Eliminated references to deprecated MCP/ subdirectory content - Enhanced navigation with contextual cross-references - Maintained DRY compliance with single source of truth linking
1 parent a0a5ba4 commit 79086a0

File tree

3 files changed

+18
-3
lines changed

3 files changed

+18
-3
lines changed

docs/articles/users/GettingStarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Now that you have Hatch installed and understand the basics:
236236
1. **Complete the tutorial series**:
237237
- [Environment Management](tutorials/02-environments/) - Advanced environment operations
238238
- [Package Authoring](tutorials/03-author-package/) - Create your own packages
239-
- [CI Automation](tutorials/04-ci-automation/) - Set up automated workflows
239+
- [MCP Host Configuration](tutorials/04-mcp-host-configuration/) - Deploy packages to host platforms
240240

241241
2. **Explore reference documentation**:
242242
- [CLI Reference](CLIReference.md) - Complete command documentation

docs/articles/users/MCPHostConfiguration.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ Hatch currently supports configuration for these MCP host platforms:
2222
- **LM Studio** - Local language model interface
2323
- **Gemini** - Google's AI development environment
2424

25+
## Hands-on Learning
26+
27+
For step-by-step guidance on MCP host configuration, see the comprehensive tutorial series:
28+
29+
- [Tutorial: Host Platform Overview](tutorials/04-mcp-host-configuration/01-host-platform-overview.md) - Understanding host platforms and deployment approaches
30+
- [Tutorial: Configuring Hatch Packages](tutorials/04-mcp-host-configuration/02-configuring-hatch-packages.md) - **Preferred deployment method** with automatic dependency resolution
31+
- [Tutorial: Configuring Arbitrary Servers](tutorials/04-mcp-host-configuration/03-configuring-arbitrary-servers.md) - Advanced method for non-Hatch servers
32+
- [Tutorial: Environment Synchronization](tutorials/04-mcp-host-configuration/04-environment-synchronization.md) - Cross-environment deployment workflows
33+
- [Tutorial: Advanced Synchronization](tutorials/04-mcp-host-configuration/05-advanced-synchronization.md) - Enterprise patterns and automation
34+
2535
## Basic Usage
2636

2737
### Configure a Server
@@ -147,7 +157,7 @@ hatch mcp configure weather-server \
147157

148158
### Advanced Synchronization
149159

150-
Hatch provides comprehensive synchronization capabilities for managing MCP configurations across environments and hosts. For detailed information, see [Synchronization Commands](MCP/synchronization_commands.md).
160+
Hatch provides comprehensive synchronization capabilities for managing MCP configurations across environments and hosts. For hands-on learning, see [Tutorial: Environment Synchronization](tutorials/04-mcp-host-configuration/04-environment-synchronization.md) and [Tutorial: Advanced Synchronization](tutorials/04-mcp-host-configuration/05-advanced-synchronization.md).
151161

152162
#### Quick Examples
153163

docs/articles/users/tutorials/03-author-package/05-checkpoint.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,13 @@
1111

1212
**Next steps:**
1313

14+
- Deploy your packages to MCP host platforms with [MCP Host Configuration](../04-mcp-host-configuration/)
1415
- Explore advanced CLI features and configuration options
1516
- Learn about security considerations and troubleshooting
1617
- Understand the development architecture for contributing
1718

18-
You now have the fundamental skills to create, validate, and install Hatch packages. For more advanced topics, explore the [CLI Reference](../../CLIReference.md) and [Security and Trust](../../SecurityAndTrust.md) guides.
19+
You now have the fundamental skills to create, validate, and install Hatch packages.
20+
21+
**Continue to**: [Tutorial 04: MCP Host Configuration](../04-mcp-host-configuration/01-host-platform-overview.md) to learn how to deploy your packages to host platforms like Claude Desktop, VS Code, and Cursor with automatic dependency resolution.
22+
23+
For more advanced topics, explore the [CLI Reference](../../CLIReference.md) and [Security and Trust](../../SecurityAndTrust.md) guides.

0 commit comments

Comments
 (0)