Add comprehensive problem-oriented how-to guides following Diátaxis framework:
- Block specific bots from crawling the site
- Customize LLM instructions for AI assistants
- Add team members to humans.txt
- Filter sitemap pages
- Configure cache headers for discovery files
- Environment-specific configuration
- Integration with Astro content collections
- Custom templates for discovery files
- ActivityPub/Fediverse integration via WebFinger
Each guide provides:
- Clear prerequisites
- Step-by-step solutions
- Multiple approaches/variations
- Expected outcomes
- Alternative approaches
- Common issues and troubleshooting
Total: 9 guides, 6,677 words
Completed comprehensive, learning-oriented tutorial content following Diátaxis framework:
Getting Started pages:
- first-steps.md: Hands-on exploration of generated files with step-by-step verification
- installation.md and quick-start.md: Already completed with clear installation paths
Tutorial pages:
- basic-setup.md: Progressive configuration from minimal to complete setup
- configure-robots.md: Bot access control with practical examples
- setup-llms.md: AI assistant context with instructions and API documentation
- create-humans.md: Team credits, tech stack, and project story
- security-canary.md: RFC 9116 security.txt and warrant canary implementation
- webfinger.md: Federated discovery for ActivityPub and OpenID Connect
All tutorials follow Diátaxis principles:
- Step-by-step instructions that work for everyone
- Concrete code examples with expected output
- Build and verify commands after each step
- Focus on getting learners started with confidence
- Minimal explanation, maximum hands-on practice
- Progressive complexity building on previous steps
Documentation verified with successful docs build.
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
