Repository navigation
Open
Labels
area: toolingDevelopment tools and utilitiesDevelopment tools and utilitiesenhancementNew feature or requestNew feature or requestpriority: mediumStandard priorityStandard priority
Description
Enhancement Request
Implement automated link validation workflows across all DollhouseMCP repositories to ensure documentation accuracy.
Background
Multiple PRs and reviews have identified broken or unverified external links in our documentation. This is part of a broader need for link validation across the organization.
Scope
Apply to all repositories:
- business (already has issue Deep linking content verification for factual claims #5)
- developer-kit (this repository)
- mcp-server
- tools-internal
- collection
- website
Requirements
GitHub Actions Workflow
- Validate all external links in markdown files
- Check internal cross-repository references
- Run on PR submissions and scheduled intervals
- Generate actionable reports for broken links
Link Quality Standards
- Verify URLs point to expected content (not just 200 responses)
- Check for deep links vs top-level pages
- Validate that linked content supports the claims being made
- Track link freshness and update frequency
Deep Linking Verification
- Ensure documentation links point to specific sections
- Verify citations link to actual source content
- Check that factual claims have proper deep links to evidence
- Implement content validation for referenced material
Implementation
Suggested Tools
- action for basic link validation
- Custom script for deep link content verification
- Scheduled workflow to catch link rot over time
Workflow Configuration
Error Handling
- Non-blocking for external links (may be temporary)
- Blocking for internal cross-repository links
- Clear reporting of which links need attention
Acceptance Criteria
- All repositories have link validation enabled
- PRs automatically check new/changed links
- Regular monitoring catches link rot
- Clear guidelines for contributors about link standards
Priority
Medium-High - Important for documentation credibility but not blocking immediate work
Related Issues
- business#5: Internal link validation workflow
- This addresses broader organizational need identified across multiple repos
Reference
- PR RAPPEL Framework Comparison and MCP Platform Documentation #1 review feedback on link validation needs
- Previous instances of broken links in documentation
Metadata
Metadata
Assignees
Labels
area: toolingDevelopment tools and utilitiesDevelopment tools and utilitiesenhancementNew feature or requestNew feature or requestpriority: mediumStandard priorityStandard priority
Activity
Address PR review feedback and improve documentation structure
RAPPEL Framework Comparison and MCP Platform Documentation (#1)