Add complete Reference documentation for all @astrojs/discovery configuration
and API surfaces following Diátaxis information-oriented principles:
Reference pages completed:
- configuration.md: Main configuration interface with all options
- robots.md: Complete robots.txt configuration reference
- llms.md: Complete llms.txt configuration reference
- humans.md: Complete humans.txt configuration reference
- security.md: RFC 9116 compliant security.txt reference
- canary.md: Warrant canary configuration reference
- webfinger.md: RFC 7033 WebFinger configuration reference
- sitemap.md: Sitemap configuration (via @astrojs/sitemap)
- cache.md: HTTP caching configuration reference
- typescript.md: Complete TypeScript type definitions
- api.md: Programmatic API reference
Documentation characteristics:
- Information-oriented: Describes the machinery accurately
- Austere and to the point: No tutorials, just facts
- Structure around code: Follows TypeScript interfaces
- Consistent structure: All pages follow same format
- Do nothing but describe: Pure reference material
- Provide examples: Code examples for all options
- Be accurate: Matches actual implementation
Each page includes:
- TypeScript interface definitions
- Property descriptions with types and defaults
- Code examples for all configuration options
- Common patterns and use cases
- Output location and format information
- Best practices where applicable
All 11 reference pages now provide complete, accurate API documentation
suitable for experienced users who need to look up specific details.
- Created comprehensive Diátaxis-based documentation
- 53 pages across Tutorials, How-to, Reference, and Explanation
- Custom branding with @astrojs/discovery logo
- Pagefind search integration
- Ready for content population
