- Follow Copilot guidelines for naming instructions files according to the directory they apply to
- Copy instructions files as CLAUDE.md to the relevant directory.
- Update placeholder instructions
- Optimize Copilot instructions
- Remove Claude instructions and reference the Copilot instructions file instead
TODO: update the commit hook script to correctly generate and place the files.
- Add GitHub Actions for automated link validation on PRs
- Implement incremental validation with caching (30-day TTL, configurable)
- Add matrix generator for parallel validation strategy
- Create comprehensive TESTING.md documentation
- Add cache manager with configurable TTL via env var or CLI
- Implement smart link extraction and validation
- Add PR comment generator for broken link reports
- Update Cypress tests to use incremental validation
- Consolidate testing docs from CONTRIBUTING.md to TESTING.md
Key improvements:
- Cache-aware validation only checks changed content
- Parallel execution for large changesets
- Detailed PR comments with broken link reports
- Support for LINK_CACHE_TTL_DAYS env var
- Local testing with yarn test:links
- Reduced false positives through intelligent caching
The CLAUDE.md file successfully references 5 key files, all of which exist and are accessible:
1. @README → README.md - Project overview and setup
2. @package.json → package.json - NPM scripts and dependencies
3. @.github/copilot-instructions.md → Main style guidelines and product info
4. @.github/instructions/contributing.instructions.md → Detailed contributing guide
5. @.github/instructions/influxdb3-code-placeholders.instructions.md → InfluxDB 3 specific
guidelines
📊 Current Structure Analysis
The CLAUDE.md file acts as a minimal index that:
- Delegates detailed instructions to other files
- Uses Claude's @ symbol notation for file references
- Provides a clear hierarchy of information
💡 Key Instructions Coverage
Through the linked files, Claude has access to:
- Product documentation paths for all InfluxDB versions
- Style guidelines following Google Developer Documentation standards
- Shortcode usage with extensive examples
- Testing procedures including pytest-codeblocks
- Development workflows with Docker and Node.js
- Placeholder conventions for code examples
- Frontmatter requirements for Hugo pages
Copilot
Jason Stirnaman
Jason Stirnaman