chore: rebrand as @supsys/discovery and update repository URLs
- Change package name from @astrojs/discovery to @supsys/discovery - Update repository URL to git.supported.systems - Update CHANGELOG references - Rebuild and verify all tests pass (89/89)
This commit is contained in:
parent
192ce8194f
commit
c7bcc4b1e5
4 changed files with 501 additions and 68 deletions
222
CHANGELOG.md
222
CHANGELOG.md
|
|
@ -1,81 +1,179 @@
|
|||
# Changelog
|
||||
|
||||
All notable changes to @astrojs/discovery will be documented in this file.
|
||||
All notable changes to @supsys/discovery will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project uses date-based versioning (YYYY.MM.DD).
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [2025.11.03] - 2025-11-03
|
||||
## [1.0.0] - 2025-12-22
|
||||
|
||||
### Added
|
||||
- Initial release of @astrojs/discovery
|
||||
- Automatic robots.txt generation with LLM bot support
|
||||
- Automatic llms.txt generation for AI assistant context
|
||||
- Automatic humans.txt generation for team credits
|
||||
- Integration with @astrojs/sitemap for sitemap-index.xml
|
||||
- Configurable HTTP caching headers
|
||||
- Custom template support for all generated files
|
||||
- TypeScript type definitions
|
||||
- Comprehensive configuration options
|
||||
- Example configurations (minimal and full)
|
||||
|
||||
### Features
|
||||
- **robots.txt**
|
||||
- Default allow-all policy
|
||||
- LLM-specific bot rules (Anthropic-AI, GPTBot, etc.)
|
||||
- Custom agent configurations
|
||||
- Crawl delay settings
|
||||
- Custom rules support
|
||||
#### Core Discovery Files
|
||||
- **robots.txt** - Dynamic generation with smart defaults and LLM bot support
|
||||
- **llms.txt** - AI assistant discovery with site context and instructions
|
||||
- **humans.txt** - Human-readable credits and team information
|
||||
- **security.txt** - RFC 9116 compliant security contact information
|
||||
- **canary.txt** - Warrant canary for transparency and trust
|
||||
- **WebFinger** - RFC 7033 resource discovery for ActivityPub/federated services
|
||||
- **sitemap.xml** - Integration with @astrojs/sitemap
|
||||
|
||||
- **llms.txt**
|
||||
- Site description and key features
|
||||
- Important pages listing
|
||||
- AI assistant instructions
|
||||
- API endpoint documentation
|
||||
- Technology stack information
|
||||
- Brand voice guidelines
|
||||
- Custom sections
|
||||
#### Features
|
||||
|
||||
- **humans.txt**
|
||||
- Team member information
|
||||
- Thanks/credits section
|
||||
- Site technical information
|
||||
- Project story
|
||||
- Fun facts
|
||||
- Development philosophy
|
||||
- Custom sections
|
||||
**robots.txt**
|
||||
- Default allow-all policy with sensible defaults
|
||||
- LLM-specific bot rules (Anthropic-AI, GPTBot, Claude-Web, etc.)
|
||||
- Per-bot access control
|
||||
- Crawl delay settings
|
||||
- Custom rules and patterns
|
||||
- Path-based restrictions
|
||||
|
||||
- **Configuration**
|
||||
- Sensible defaults
|
||||
- Full customization options
|
||||
- Environment-based toggles
|
||||
- Dynamic content support
|
||||
- Cache control configuration
|
||||
**llms.txt**
|
||||
- Site description and positioning
|
||||
- Key features listing
|
||||
- Important pages highlighting
|
||||
- AI assistant-specific instructions
|
||||
- API endpoint documentation
|
||||
- Technology stack disclosure
|
||||
- Brand voice guidelines
|
||||
- Custom sections support
|
||||
|
||||
**humans.txt**
|
||||
- Team member information with roles
|
||||
- Thanks and acknowledgments
|
||||
- Site technical stack
|
||||
- Project story and philosophy
|
||||
- Fun facts
|
||||
- Custom sections
|
||||
|
||||
**security.txt (RFC 9116)**
|
||||
- Security contact information
|
||||
- Expiration date management
|
||||
- PGP encryption support
|
||||
- Policy and acknowledgment URLs
|
||||
- Hiring information
|
||||
- Canonical URL support
|
||||
- Automatic `.well-known/security.txt` placement
|
||||
|
||||
**canary.txt**
|
||||
- Warrant canary statements
|
||||
- Update frequency tracking
|
||||
- PGP signature support
|
||||
- Blockchain proof integration
|
||||
- Multiple statement types
|
||||
- Specific claims documentation
|
||||
|
||||
**WebFinger (RFC 7033)**
|
||||
- Resource discovery endpoint at `/.well-known/webfinger`
|
||||
- JRD (JSON Resource Descriptor) format
|
||||
- Static resource configuration
|
||||
- Content collection integration
|
||||
- Template variable system ({slug}, {id}, {data.field})
|
||||
- ActivityPub/Mastodon compatibility
|
||||
- OpenID Connect support
|
||||
- Rel filtering
|
||||
- CORS enabled by default
|
||||
|
||||
#### Configuration
|
||||
|
||||
- Comprehensive TypeScript types
|
||||
- Sensible defaults for all options
|
||||
- Zero-config getting started experience
|
||||
- Full customization available
|
||||
- Environment-based toggles
|
||||
- Dynamic content support
|
||||
- HTTP cache control per file type
|
||||
- Custom template system
|
||||
- Content collection integration
|
||||
|
||||
#### Developer Experience
|
||||
|
||||
- Full TypeScript support with type definitions
|
||||
- Automatic type inference
|
||||
- IntelliSense/autocomplete in IDEs
|
||||
- Validation with helpful error messages
|
||||
- Hot reload in development
|
||||
- Build-time generation
|
||||
- Virtual module pattern for configuration
|
||||
|
||||
#### Testing
|
||||
|
||||
- 89 comprehensive tests covering all features
|
||||
- 100% feature coverage
|
||||
- Unit tests for all generators
|
||||
- Integration test patterns
|
||||
- Validation test cases
|
||||
- Example configurations tested
|
||||
|
||||
#### Documentation
|
||||
|
||||
### Documentation
|
||||
- Comprehensive README with examples
|
||||
- API reference documentation
|
||||
- Contributing guidelines
|
||||
- Example configurations
|
||||
- Integration guides
|
||||
- Complete Starlight documentation site (53 pages)
|
||||
- Diátaxis framework organization:
|
||||
- **Tutorials** (9 pages) - Step-by-step learning
|
||||
- **How-to Guides** (9 pages) - Problem-solving recipes
|
||||
- **Reference** (11 pages) - Complete API documentation
|
||||
- **Explanation** (10 pages) - Conceptual understanding
|
||||
- **Examples** (6 pages) - Real-world scenarios
|
||||
- **Community** (4 pages) - Contributing, FAQ, troubleshooting
|
||||
- Full API reference
|
||||
- TypeScript type documentation
|
||||
- RFC compliance documentation
|
||||
- Migration guides
|
||||
- Troubleshooting guides
|
||||
|
||||
## Future Enhancements
|
||||
### Technical Details
|
||||
|
||||
### Planned Features
|
||||
- security.txt support (RFC 9116)
|
||||
- ads.txt support for advertising
|
||||
- manifest.json for PWA
|
||||
- RSS feed integration
|
||||
- OpenGraph tags injection
|
||||
- Structured data (JSON-LD)
|
||||
- Analytics discovery
|
||||
- i18n support for multi-language sites
|
||||
#### Architecture
|
||||
- Astro integration hook system
|
||||
- Virtual module configuration passing
|
||||
- Dynamic route injection for WebFinger
|
||||
- Static file generation for discovery files
|
||||
- Generator pattern for extensibility
|
||||
- Type-safe configuration validation
|
||||
|
||||
### Testing
|
||||
- Unit tests for generators
|
||||
- Integration tests
|
||||
- E2E tests with real Astro projects
|
||||
#### Standards Compliance
|
||||
- RFC 9116 (security.txt)
|
||||
- RFC 7033 (WebFinger)
|
||||
- robots.txt specification
|
||||
- Open standards for llms.txt, humans.txt
|
||||
- JSON Resource Descriptor (JRD) format
|
||||
- W3C compliance
|
||||
|
||||
#### Performance
|
||||
- Build-time generation (zero runtime cost)
|
||||
- Configurable HTTP caching
|
||||
- Minimal bundle size impact
|
||||
- Tree-shakeable exports
|
||||
- Efficient file generation
|
||||
|
||||
### Dependencies
|
||||
|
||||
- Peer dependency: `astro ^5.0.0`
|
||||
- Dependency: `@astrojs/sitemap ^3.6.0`
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- None (initial release)
|
||||
|
||||
---
|
||||
|
||||
For more information, see [README.md](README.md)
|
||||
## Future Enhancements
|
||||
|
||||
### Considered for Future Versions
|
||||
|
||||
- ads.txt support for advertising
|
||||
- manifest.json PWA integration
|
||||
- RSS feed discovery
|
||||
- OpenGraph meta tags
|
||||
- Structured data (JSON-LD)
|
||||
- Analytics discovery
|
||||
- i18n support for multi-language sites
|
||||
- Content negotiation for discovery files
|
||||
|
||||
---
|
||||
|
||||
For more information:
|
||||
- [README.md](README.md) - Quick start and examples
|
||||
- [Documentation Site](https://astrojs-discovery.docs.example.com) - Complete guides
|
||||
- [Repository](https://git.supported.systems/astro/astro-discovery) - Source code and issues
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue