Skip to content

Commit e911324

Browse files
author
LittleCoinCoin
committed
fix(docs): repair all broken links
1 parent 390ddff commit e911324

File tree

19 files changed

+50
-76
lines changed

19 files changed

+50
-76
lines changed

docs/articles/devs/architecture/component_architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,5 +287,5 @@ This article is about:
287287
## Related Documentation
288288

289289
- [System Overview](./system_overview.md) - High-level architecture introduction
290-
- [Implementation Guides](../implementation_guides/) - Technical implementation guidance for specific components
291-
- [Development Processes](../development_processes/) - Development workflow and testing standards
290+
- [Implementation Guides](../implementation_guides/index.md) - Technical implementation guidance for specific components
291+
- [Development Processes](../development_processes/index.md) - Development workflow and testing standards

docs/articles/devs/architecture/index.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Design patterns are covered within the main architecture documents:
2222

2323
## Architecture Diagram
2424

25-
The complete system architecture is documented in the [Architecture Diagram](../../resources/diagrams/architecture.puml), which provides a visual overview of all components and their relationships.
25+
![Component Architecture](../../../resources/images/architecture.svg)
2626

2727
## Key Architectural Principles
2828

@@ -36,12 +36,11 @@ The complete system architecture is documented in the [Architecture Diagram](../
3636
If you're new to the Hatch codebase:
3737

3838
1. Start with [System Overview](./system_overview.md) to understand the big picture
39-
2. Review the [Architecture Diagram](../../resources/diagrams/architecture.puml) for visual context
40-
3. Explore [Component Architecture](./component_architecture.md) for detailed component understanding
41-
4. Check [Implementation Guides](../implementation_guides/) when ready to work on specific features
39+
2. Explore [Component Architecture](./component_architecture.md) for detailed component understanding
40+
3. Check [Implementation Guides](../implementation_guides/index.md) when ready to work on specific features
4241

4342
## Related Documentation
4443

45-
- [Implementation Guides](../implementation_guides/) - Technical how-to guides for specific components
46-
- [Development Processes](../development_processes/) - Development workflow and standards
47-
- [Contribution Guidelines](../contribution_guides/) - How to contribute to the project
44+
- [Implementation Guides](../implementation_guides/index.md) - Technical how-to guides for specific components
45+
- [Development Processes](../development_processes/index.md) - Development workflow and standards
46+
- [Contribution Guidelines](../contribution_guides/index.md) - How to contribute to the project

docs/articles/devs/architecture/system_overview.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -142,10 +142,4 @@ Understanding this system overview provides the foundation for working with Hatc
142142
1. **Start Here** - This overview gives you the big picture
143143
2. **Dive Deeper** - See [Component Architecture](./component_architecture.md) for detailed component information
144144
3. **Get Hands-On** - Follow [Developer Onboarding](../development_processes/developer_onboarding.md) for practical next steps
145-
4. **Implementation** - Check [Implementation Guides](../implementation_guides/) when ready to implement features
146-
147-
## Related Documentation
148-
149-
- [Component Architecture](./component_architecture.md) - Detailed component breakdown
150-
- [Implementation Guides](../implementation_guides/) - Technical implementation guidance
151-
- [Development Processes](../development_processes/) - Development workflow and standards
145+
4. **Implementation** - Check [Implementation Guides](../implementation_guides/index.md) when ready to implement features

docs/articles/devs/contribution_guides/index.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ This section provides process-focused guidance for contributing to the Hatch pro
44

55
## Overview
66

7-
These guidelines focus on the contribution process, community standards, and project policies rather than technical implementation details. For technical how-to guides, see [Implementation Guides](../implementation_guides/).
7+
These guidelines focus on the contribution process, community standards, and project policies rather than technical implementation details. For technical how-to guides, see [Implementation Guides](../implementation_guides/index.md).
88

99
## Available Guidelines
1010

1111
### Core Contribution Process
1212

1313
- **[How to Contribute](./how_to_contribute.md)** - General contribution workflow, branch naming, and submission process
14-
- **[Release and Dependency Policy](./release_and_dependency_policy.md)** - Release management policies and dependency guidelines
14+
- **[Release and Dependency Policy](./release_policy.md)** - Release management policies and dependency guidelines
1515

1616
## Before Contributing
1717

18-
1. **Review the Architecture** - Understand the system by reading [Architecture Documentation](../architecture/)
19-
2. **Set Up Development Environment** - Follow [Development Environment Setup](../development_processes/development_environment_setup.md)
18+
1. **Review the Architecture** - Understand the system by reading [Architecture Documentation](../architecture/index.md)
19+
2. **Set Up Development Environment** - Follow [Development Environment Setup](../development_processes/developer_onboarding.md)
2020
3. **Understand Testing Requirements** - Review [Testing Standards](../development_processes/testing_standards.md)
21-
4. **Check Implementation Guides** - For technical guidance, see [Implementation Guides](../implementation_guides/)
21+
4. **Check Implementation Guides** - For technical guidance, see [Implementation Guides](../implementation_guides/index.md)
2222

2323
## Contribution Workflow
2424

@@ -37,6 +37,4 @@ These guidelines focus on the contribution process, community standards, and pro
3737

3838
## Related Documentation
3939

40-
- [Development Processes](../development_processes/) - Development workflow and standards
41-
- [Implementation Guides](../implementation_guides/) - Technical implementation guidance
42-
- [Architecture](../architecture/) - System understanding for contributors
40+
- [Development Processes](../development_processes/index.md) - Development workflow and standards

docs/articles/devs/development_processes/developer_onboarding.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,7 @@ hatch --help
6363
### Start with High-Level Architecture
6464

6565
1. **Read** [System Overview](../architecture/system_overview.md) - Understand the big picture
66-
2. **Review** [Architecture Diagram](../../resources/diagrams/architecture.puml) - Visual system layout
67-
3. **Examine** [Component Architecture](../architecture/component_architecture.md) - Detailed component breakdown
66+
2. **Examine** [Component Architecture](../architecture/component_architecture.md) - Detailed component breakdown
6867

6968
### Key Files to Understand
7069

docs/articles/devs/development_processes/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@ All development must follow the [organization-wide](https://github.com/CrackingS
4646

4747
## Related Documentation
4848

49-
- [Architecture](../architecture/) - Understanding the system you're working on
50-
- [Implementation Guides](../implementation_guides/) - Technical how-to guides for specific features
51-
- [Contribution Guidelines](../contribution_guides/) - Process for contributing your work
49+
- [Architecture](../architecture/index.md) - Understanding the system you're working on
50+
- [Implementation Guides](../implementation_guides/index.md) - Technical how-to guides for specific features
51+
- [Contribution Guidelines](../contribution_guides/index.md) - Process for contributing your work

docs/articles/devs/development_processes/testing_standards.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,6 @@ class TestRegistryCaching(unittest.TestCase):
263263

264264
## Related Documentation
265265

266-
- [Development Environment Setup](./development_environment_setup.md) - Setting up testing environment
266+
- [Development Environment Setup](./developer_onboarding.md) - Setting up testing environment
267267
- [Contribution Guidelines](../contribution_guides/how_to_contribute.md) - Testing requirements for contributions
268-
- [Implementation Guides](../implementation_guides/) - Testing specific components
268+
- [Implementation Guides](../implementation_guides/index.md) - Testing specific components

docs/articles/devs/index.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,31 @@ This section provides comprehensive documentation for developers and contributor
66

77
The developer documentation is organized into four main categories to serve different developer needs:
88

9-
### [Architecture](./architecture/)
9+
### [Architecture](./architecture/index.md)
1010

1111
High-level system understanding and design patterns for developers getting familiar with the Hatch codebase.
1212

1313
- System overview and component relationships
1414
- Design patterns and architectural decisions
1515
- Entry points for new developers
1616

17-
### [Implementation Guides](./implementation_guides/)
17+
### [Implementation Guides](./implementation_guides/index.md)
1818

1919
Technical how-to guides for implementing specific features and extending the system.
2020

2121
- Adding new installer types
2222
- Extending core functionality
2323
- Working with specific system components
2424

25-
### [Development Processes](./development_processes/)
25+
### [Development Processes](./development_processes/index.md)
2626

2727
Workflow, standards, and processes for effective development on the Hatch project.
2828

2929
- Testing standards and procedures
3030
- Development environment setup
3131
- Code quality and review processes
3232

33-
### [Contribution Guidelines](./contribution_guides/)
33+
### [Contribution Guidelines](./contribution_guides/index.md)
3434

3535
Process-focused guidance for contributing to the Hatch project.
3636

@@ -48,18 +48,15 @@ Process-focused guidance for contributing to the Hatch project.
4848

4949
### For Experienced Developers
5050

51-
1. **Implementing Features**[Implementation Guides](./implementation_guides/) - Technical how-to guides
51+
1. **Implementing Features**[Implementation Guides](./implementation_guides/index.md) - Technical how-to guides
5252
2. **Understanding Components**[Component Architecture](./architecture/component_architecture.md) - Detailed component breakdown
5353
3. **Testing Requirements**[Testing Standards](./development_processes/testing_standards.md) - Testing patterns and requirements
54-
4. **Release Process**[Release and Dependency Policy](./contribution_guides/release_and_dependency_policy.md) - Release management policies
54+
4. **Release Process**[Release and Dependency Policy](./contribution_guides/release_policy.md) - Release management policies
5555

56-
## Additional Resources
5756

58-
- **[Architecture Diagram](../../resources/diagrams/architecture.puml)** - Visual overview of system components
5957

6058
### External Resources
6159

62-
- **[Source Code](../../hatch/)** - Main Hatch package source code
6360
- **[GitHub Repository](https://github.com/CrackingShells/Hatch)** - Project repository
6461
- **[Hatch Schemas](https://github.com/CrackingShells/Hatch-Schemas)** - Package metadata schemas
6562
- **[Hatch Registry](https://github.com/CrackingShells/Hatch-Registry)** - Central package registry

docs/articles/users/GettingStarted.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -238,24 +238,17 @@ Now that you have Hatch installed and understand the basics:
238238
### Next Steps
239239

240240
1. **Complete the tutorial series**:
241-
- [Environment Management](tutorials/02-environments/) - Advanced environment operations
242-
- [Package Authoring](tutorials/03-author-package/) - Create your own packages
243-
- [MCP Host Configuration](tutorials/04-mcp-host-configuration/) - Deploy packages to host platforms
241+
- [Environment Management](tutorials/02-environments/01-manage-envs.md) - Advanced environment operations
242+
- [Package Authoring](tutorials/03-author-package/01-generate-template.md) - Create your own packages
243+
- [MCP Host Configuration](tutorials/04-mcp-host-configuration/01-host-platform-overview.md) - Deploy packages to host platforms
244244

245245
2. **Explore reference documentation**:
246246
- [CLI Reference](CLIReference.md) - Complete command documentation
247-
- [Troubleshooting](Troubleshooting/CommonIssues.md) - Solutions to common issues
248247

249248
3. **Understand limitations**:
250249
- [Limits and Known Issues](../appendices/LimitsAndKnownIssues.md) - Current constraints and workarounds
251250
- [Security and Trust](SecurityAndTrust.md) - Security model and deployment guidance
252251

253-
### Getting Help
254-
255-
**Documentation**: Start with the [troubleshooting guide](Troubleshooting/CommonIssues.md) for common issues.
256-
257-
**Community**: Check the GitHub repository for issues and discussions.
258-
259252
**Diagnostics**: Use these commands to gather information when seeking help:
260253
```bash
261254
hatch --help

docs/articles/users/MCPHostConfiguration.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,6 @@ hatch mcp configure weather_server \
154154
--args weather_server.py
155155
```
156156

157-
### Advanced Synchronization
158-
159-
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).
160-
161157
#### Quick Examples
162158

163159
```bash
@@ -472,4 +468,4 @@ The system validates host names against available MCP host types:
472468

473469
Invalid host names result in clear error messages with available options listed.
474470

475-
For complete command syntax and all available options, see [CLI Reference](CLIReference.md#mcp-commands).
471+
For complete command syntax and all available options, see [CLI Reference](CLIReference.md).

0 commit comments

Comments
 (0)