docs: Standardize all IndieAuth spec references to W3C URL
- Updated 42 references from indieauth.spec.indieweb.org to www.w3.org/TR/indieauth - Ensures consistency across all documentation - Points to the authoritative W3C specification - No functional changes, documentation update only Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -155,7 +155,7 @@ See [docs/architecture/](docs/architecture/) for complete documentation.
|
|||||||
|
|
||||||
StarPunk implements:
|
StarPunk implements:
|
||||||
- [Micropub](https://micropub.spec.indieweb.org/) - Publishing API
|
- [Micropub](https://micropub.spec.indieweb.org/) - Publishing API
|
||||||
- [IndieAuth](https://indieauth.spec.indieweb.org/) - Authentication
|
- [IndieAuth](https://www.w3.org/TR/indieauth/) - Authentication
|
||||||
- [Microformats2](http://microformats.org/) - Semantic HTML markup
|
- [Microformats2](http://microformats.org/) - Semantic HTML markup
|
||||||
- [RSS 2.0](https://www.rssboard.org/rss-specification) - Feed syndication
|
- [RSS 2.0](https://www.rssboard.org/rss-specification) - Feed syndication
|
||||||
|
|
||||||
|
|||||||
@@ -134,6 +134,6 @@ After fixing:
|
|||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
- [IndieAuth Spec - Client Information Discovery](https://indieauth.spec.indieweb.org/#client-information-discovery)
|
- [IndieAuth Spec - Client Information Discovery](https://www.w3.org/TR/indieauth/#client-information-discovery)
|
||||||
- [Microformats h-app](http://microformats.org/wiki/h-app)
|
- [Microformats h-app](http://microformats.org/wiki/h-app)
|
||||||
- [IndieWeb Client ID](https://indieweb.org/client_id)
|
- [IndieWeb Client ID](https://indieweb.org/client_id)
|
||||||
@@ -149,7 +149,7 @@ See `/docs/examples/identity-page.html` for a complete, working example that can
|
|||||||
|
|
||||||
## Standards References
|
## Standards References
|
||||||
|
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [Microformats2 h-card](http://microformats.org/wiki/h-card)
|
- [Microformats2 h-card](http://microformats.org/wiki/h-card)
|
||||||
- [rel="me" specification](https://microformats.org/wiki/rel-me)
|
- [rel="me" specification](https://microformats.org/wiki/rel-me)
|
||||||
- [IndieWeb Authentication](https://indieweb.org/authentication)
|
- [IndieWeb Authentication](https://indieweb.org/authentication)
|
||||||
@@ -1123,7 +1123,7 @@ The architecture is successful if it enables:
|
|||||||
|
|
||||||
### External Standards
|
### External Standards
|
||||||
- [IndieWeb](https://indieweb.org/)
|
- [IndieWeb](https://indieweb.org/)
|
||||||
- [IndieAuth Spec](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Spec](https://www.w3.org/TR/indieauth/)
|
||||||
- [Micropub Spec](https://micropub.spec.indieweb.org/)
|
- [Micropub Spec](https://micropub.spec.indieweb.org/)
|
||||||
- [Microformats2](http://microformats.org/wiki/h-entry)
|
- [Microformats2](http://microformats.org/wiki/h-entry)
|
||||||
- [RSS 2.0](https://www.rssboard.org/rss-specification)
|
- [RSS 2.0](https://www.rssboard.org/rss-specification)
|
||||||
|
|||||||
@@ -725,7 +725,7 @@ Return success
|
|||||||
**Token Format**: Bearer tokens
|
**Token Format**: Bearer tokens
|
||||||
**Validation**: Token introspection
|
**Validation**: Token introspection
|
||||||
|
|
||||||
**Reference**: https://indieauth.spec.indieweb.org/
|
**Reference**: https://www.w3.org/TR/indieauth/
|
||||||
|
|
||||||
#### Micropub
|
#### Micropub
|
||||||
**Compliance**: Full Micropub spec support
|
**Compliance**: Full Micropub spec support
|
||||||
@@ -1061,7 +1061,7 @@ This stack embodies the project philosophy: "Every line of code must justify its
|
|||||||
|
|
||||||
### Standards and Specifications
|
### Standards and Specifications
|
||||||
- IndieWeb: https://indieweb.org/
|
- IndieWeb: https://indieweb.org/
|
||||||
- IndieAuth Spec: https://indieauth.spec.indieweb.org/
|
- IndieAuth Spec: https://www.w3.org/TR/indieauth/
|
||||||
- Micropub Spec: https://micropub.spec.indieweb.org/
|
- Micropub Spec: https://micropub.spec.indieweb.org/
|
||||||
- Microformats2: http://microformats.org/wiki/h-entry
|
- Microformats2: http://microformats.org/wiki/h-entry
|
||||||
- RSS 2.0: https://www.rssboard.org/rss-specification
|
- RSS 2.0: https://www.rssboard.org/rss-specification
|
||||||
|
|||||||
@@ -416,6 +416,6 @@ SESSION_SECRET=your-random-secret-key-here
|
|||||||
## References
|
## References
|
||||||
- IndieLogin.com: https://indielogin.com/
|
- IndieLogin.com: https://indielogin.com/
|
||||||
- IndieLogin API Documentation: https://indielogin.com/api
|
- IndieLogin API Documentation: https://indielogin.com/api
|
||||||
- IndieAuth Specification: https://indieauth.spec.indieweb.org/
|
- IndieAuth Specification: https://www.w3.org/TR/indieauth/
|
||||||
- OAuth 2.0 Spec: https://oauth.net/2/
|
- OAuth 2.0 Spec: https://oauth.net/2/
|
||||||
- Web Authentication Best Practices: https://cheatsheetseries.owasp.org/cheatsheets/Authentication_Cheat_Sheet.html
|
- Web Authentication Best Practices: https://cheatsheetseries.owasp.org/cheatsheets/Authentication_Cheat_Sheet.html
|
||||||
|
|||||||
@@ -205,7 +205,7 @@ Balance between security and usability:
|
|||||||
## References
|
## References
|
||||||
|
|
||||||
- [ADR-005: IndieLogin Authentication](/home/phil/Projects/starpunk/docs/decisions/ADR-005-indielogin-authentication.md)
|
- [ADR-005: IndieLogin Authentication](/home/phil/Projects/starpunk/docs/decisions/ADR-005-indielogin-authentication.md)
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [OWASP Session Management](https://cheatsheetseries.owasp.org/cheatsheets/Session_Management_Cheat_Sheet.html)
|
- [OWASP Session Management](https://cheatsheetseries.owasp.org/cheatsheets/Session_Management_Cheat_Sheet.html)
|
||||||
- [Flask Security Best Practices](https://flask.palletsprojects.com/en/3.0.x/security/)
|
- [Flask Security Best Practices](https://flask.palletsprojects.com/en/3.0.x/security/)
|
||||||
|
|
||||||
|
|||||||
@@ -283,7 +283,7 @@ This allows gradual migration without breaking existing integrations.
|
|||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [Microformats2 h-app](https://microformats.org/wiki/h-app)
|
- [Microformats2 h-app](https://microformats.org/wiki/h-app)
|
||||||
- [IndieLogin.com](https://indielogin.com/)
|
- [IndieLogin.com](https://indielogin.com/)
|
||||||
- [OAuth 2.0 Client ID Metadata Document](https://www.rfc-editor.org/rfc/rfc7591.html)
|
- [OAuth 2.0 Client ID Metadata Document](https://www.rfc-editor.org/rfc/rfc7591.html)
|
||||||
|
|||||||
@@ -162,7 +162,7 @@ def oauth_client_metadata():
|
|||||||
Returns JSON metadata about this IndieAuth client for authorization
|
Returns JSON metadata about this IndieAuth client for authorization
|
||||||
server discovery. Required by IndieAuth specification section 4.2.
|
server discovery. Required by IndieAuth specification section 4.2.
|
||||||
|
|
||||||
See: https://indieauth.spec.indieweb.org/#client-information-discovery
|
See: https://www.w3.org/TR/indieauth/#client-information-discovery
|
||||||
"""
|
"""
|
||||||
metadata = {
|
metadata = {
|
||||||
'issuer': current_app.config['SITE_URL'],
|
'issuer': current_app.config['SITE_URL'],
|
||||||
@@ -468,7 +468,7 @@ Assume IndieLogin.com has a bug and wait for them to fix it.
|
|||||||
## References
|
## References
|
||||||
|
|
||||||
### Specifications
|
### Specifications
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [OAuth Client ID Metadata Document](https://www.ietf.org/archive/id/draft-parecki-oauth-client-id-metadata-document-00.html)
|
- [OAuth Client ID Metadata Document](https://www.ietf.org/archive/id/draft-parecki-oauth-client-id-metadata-document-00.html)
|
||||||
- [RFC 7591 - OAuth 2.0 Dynamic Client Registration](https://www.rfc-editor.org/rfc/rfc7591.html)
|
- [RFC 7591 - OAuth 2.0 Dynamic Client Registration](https://www.rfc-editor.org/rfc/rfc7591.html)
|
||||||
- [RFC 3986 - URI Generic Syntax](https://www.rfc-editor.org/rfc/rfc3986)
|
- [RFC 3986 - URI Generic Syntax](https://www.rfc-editor.org/rfc/rfc3986)
|
||||||
|
|||||||
@@ -819,7 +819,7 @@ LOG_LEVEL=DEBUG
|
|||||||
- [Python Logging Documentation](https://docs.python.org/3/library/logging.html)
|
- [Python Logging Documentation](https://docs.python.org/3/library/logging.html)
|
||||||
- [OWASP Logging Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Logging_Cheat_Sheet.html)
|
- [OWASP Logging Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Logging_Cheat_Sheet.html)
|
||||||
- [OAuth 2.0 Security Best Current Practice](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics)
|
- [OAuth 2.0 Security Best Current Practice](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics)
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [Flask Logging Documentation](https://flask.palletsprojects.com/en/3.0.x/logging/)
|
- [Flask Logging Documentation](https://flask.palletsprojects.com/en/3.0.x/logging/)
|
||||||
|
|
||||||
## Related Documents
|
## Related Documents
|
||||||
|
|||||||
@@ -1298,7 +1298,7 @@ Implementation is successful when:
|
|||||||
|
|
||||||
- **PKCE Specification (RFC 7636)**: https://www.rfc-editor.org/rfc/rfc7636
|
- **PKCE Specification (RFC 7636)**: https://www.rfc-editor.org/rfc/rfc7636
|
||||||
- **OAuth 2.0 (RFC 6749)**: https://www.rfc-editor.org/rfc/rfc6749
|
- **OAuth 2.0 (RFC 6749)**: https://www.rfc-editor.org/rfc/rfc6749
|
||||||
- **IndieAuth Specification**: https://indieauth.spec.indieweb.org/ (for context only)
|
- **IndieAuth Specification**: https://www.w3.org/TR/indieauth/ (for context only)
|
||||||
|
|
||||||
### Internal Documentation
|
### Internal Documentation
|
||||||
|
|
||||||
|
|||||||
@@ -505,7 +505,7 @@ If there is user demand for a more integrated solution, V2 could add:
|
|||||||
## References
|
## References
|
||||||
|
|
||||||
### IndieAuth Specifications
|
### IndieAuth Specifications
|
||||||
- [IndieAuth Spec](https://indieauth.spec.indieweb.org/) - Official W3C specification
|
- [IndieAuth Spec](https://www.w3.org/TR/indieauth/) - Official W3C specification
|
||||||
- [OAuth 2.0](https://oauth.net/2/) - Underlying OAuth 2.0 foundation
|
- [OAuth 2.0](https://oauth.net/2/) - Underlying OAuth 2.0 foundation
|
||||||
- [Client Identifier](https://www.oauth.com/oauth2-servers/indieauth/) - How client_id works in IndieAuth
|
- [Client Identifier](https://www.oauth.com/oauth2-servers/indieauth/) - How client_id works in IndieAuth
|
||||||
|
|
||||||
|
|||||||
@@ -165,7 +165,7 @@ After implementation:
|
|||||||
5. Test full IndieAuth flow with real provider
|
5. Test full IndieAuth flow with real provider
|
||||||
|
|
||||||
## References
|
## References
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/) - Section on redirect URIs
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/) - Section on redirect URIs
|
||||||
- [OAuth 2.0 RFC 6749](https://tools.ietf.org/html/rfc6749) - Section 3.1.2 on redirection endpoints
|
- [OAuth 2.0 RFC 6749](https://tools.ietf.org/html/rfc6749) - Section 3.1.2 on redirection endpoints
|
||||||
- [RESTful API Design](https://restfulapi.net/resource-naming/) - URL naming conventions
|
- [RESTful API Design](https://restfulapi.net/resource-naming/) - URL naming conventions
|
||||||
- Current implementation: `/home/phil/Projects/starpunk/starpunk/routes/auth.py`, `/home/phil/Projects/starpunk/starpunk/auth.py`
|
- Current implementation: `/home/phil/Projects/starpunk/starpunk/routes/auth.py`, `/home/phil/Projects/starpunk/starpunk/auth.py`
|
||||||
|
|||||||
@@ -91,7 +91,7 @@ Implementation:
|
|||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
- [IndieAuth Spec Section 4.2.2](https://indieauth.spec.indieweb.org/#client-information-discovery)
|
- [IndieAuth Spec Section 4.2.2](https://www.w3.org/TR/indieauth/#client-information-discovery)
|
||||||
- [Microformats h-app](http://microformats.org/wiki/h-app)
|
- [Microformats h-app](http://microformats.org/wiki/h-app)
|
||||||
- [IndieWeb Client Information](https://indieweb.org/client-id)
|
- [IndieWeb Client Information](https://indieweb.org/client-id)
|
||||||
|
|
||||||
|
|||||||
@@ -138,7 +138,7 @@ Users should test their identity page with:
|
|||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [Microformats2 h-card](http://microformats.org/wiki/h-card)
|
- [Microformats2 h-card](http://microformats.org/wiki/h-card)
|
||||||
- [IndieWeb Authentication](https://indieweb.org/authentication)
|
- [IndieWeb Authentication](https://indieweb.org/authentication)
|
||||||
- [indieauth.com](https://indieauth.com/)
|
- [indieauth.com](https://indieauth.com/)
|
||||||
@@ -202,7 +202,7 @@ The technical implementation is documented in:
|
|||||||
### Supporting Specifications
|
### Supporting Specifications
|
||||||
- **PKCE Specification (RFC 7636)**: https://www.rfc-editor.org/rfc/rfc7636
|
- **PKCE Specification (RFC 7636)**: https://www.rfc-editor.org/rfc/rfc7636
|
||||||
- **OAuth 2.0 (RFC 6749)**: https://www.rfc-editor.org/rfc/rfc6749
|
- **OAuth 2.0 (RFC 6749)**: https://www.rfc-editor.org/rfc/rfc6749
|
||||||
- **IndieAuth Specification**: https://indieauth.spec.indieweb.org/ (context only)
|
- **IndieAuth Specification**: https://www.w3.org/TR/indieauth/ (context only)
|
||||||
|
|
||||||
### Internal Documentation
|
### Internal Documentation
|
||||||
- ADR-005: IndieLogin Authentication Integration (conceptual flow)
|
- ADR-005: IndieLogin Authentication Integration (conceptual flow)
|
||||||
|
|||||||
@@ -204,7 +204,7 @@ We will implement a **minimal but complete Micropub server** for V1, focusing on
|
|||||||
## References
|
## References
|
||||||
|
|
||||||
- [W3C Micropub Specification](https://www.w3.org/TR/micropub/)
|
- [W3C Micropub Specification](https://www.w3.org/TR/micropub/)
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [OAuth 2.0 Bearer Token Usage](https://tools.ietf.org/html/rfc6750)
|
- [OAuth 2.0 Bearer Token Usage](https://tools.ietf.org/html/rfc6750)
|
||||||
- [Micropub Rocks Validator](https://micropub.rocks/)
|
- [Micropub Rocks Validator](https://micropub.rocks/)
|
||||||
|
|
||||||
|
|||||||
@@ -518,8 +518,8 @@ DELETE FROM auth_state WHERE expires_at < datetime('now');
|
|||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
- [IndieAuth Spec - Token Endpoint](https://indieauth.spec.indieweb.org/#token-endpoint)
|
- [IndieAuth Spec - Token Endpoint](https://www.w3.org/TR/indieauth/#token-endpoint)
|
||||||
- [IndieAuth Spec - Authorization Code](https://indieauth.spec.indieweb.org/#authorization-code)
|
- [IndieAuth Spec - Authorization Code](https://www.w3.org/TR/indieauth/#authorization-code)
|
||||||
- [Micropub Spec - Authentication](https://www.w3.org/TR/micropub/#authentication)
|
- [Micropub Spec - Authentication](https://www.w3.org/TR/micropub/#authentication)
|
||||||
- [OAuth 2.0 Security Best Practices](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics)
|
- [OAuth 2.0 Security Best Practices](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics)
|
||||||
|
|
||||||
|
|||||||
@@ -427,7 +427,7 @@ See [docs/architecture/](docs/architecture/) for complete documentation.
|
|||||||
|
|
||||||
StarPunk implements:
|
StarPunk implements:
|
||||||
- [Micropub](https://micropub.spec.indieweb.org/) - Publishing API
|
- [Micropub](https://micropub.spec.indieweb.org/) - Publishing API
|
||||||
- [IndieAuth](https://indieauth.spec.indieweb.org/) - Authentication
|
- [IndieAuth](https://www.w3.org/TR/indieauth/) - Authentication
|
||||||
- [Microformats2](http://microformats.org/) - Semantic HTML markup
|
- [Microformats2](http://microformats.org/) - Semantic HTML markup
|
||||||
- [RSS 2.0](https://www.rssboard.org/rss-specification) - Feed syndication
|
- [RSS 2.0](https://www.rssboard.org/rss-specification) - Feed syndication
|
||||||
|
|
||||||
|
|||||||
@@ -534,7 +534,7 @@ After Phase 3 completion:
|
|||||||
|
|
||||||
- [ADR-005: IndieLogin Authentication](/home/phil/Projects/starpunk/docs/decisions/ADR-005-indielogin-authentication.md)
|
- [ADR-005: IndieLogin Authentication](/home/phil/Projects/starpunk/docs/decisions/ADR-005-indielogin-authentication.md)
|
||||||
- [ADR-010: Authentication Module Design](/home/phil/Projects/starpunk/docs/decisions/ADR-010-authentication-module-design.md)
|
- [ADR-010: Authentication Module Design](/home/phil/Projects/starpunk/docs/decisions/ADR-010-authentication-module-design.md)
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [IndieLogin API Documentation](https://indielogin.com/api)
|
- [IndieLogin API Documentation](https://indielogin.com/api)
|
||||||
- [OWASP Authentication Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Authentication_Cheat_Sheet.html)
|
- [OWASP Authentication Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Authentication_Cheat_Sheet.html)
|
||||||
|
|
||||||
|
|||||||
@@ -328,7 +328,7 @@ Once your identity page is working:
|
|||||||
|
|
||||||
- **IndieWeb Chat**: https://indieweb.org/discuss
|
- **IndieWeb Chat**: https://indieweb.org/discuss
|
||||||
- **StarPunk Issues**: [GitHub repository]
|
- **StarPunk Issues**: [GitHub repository]
|
||||||
- **IndieAuth Spec**: https://indieauth.spec.indieweb.org/
|
- **IndieAuth Spec**: https://www.w3.org/TR/indieauth/
|
||||||
- **Microformats Wiki**: http://microformats.org/
|
- **Microformats Wiki**: http://microformats.org/
|
||||||
|
|
||||||
Remember: The simplest solution is often the best. Don't add complexity unless you need it.
|
Remember: The simplest solution is often the best. Don't add complexity unless you need it.
|
||||||
@@ -190,7 +190,7 @@ StarPunk V1 must comply with:
|
|||||||
| RSS 2.0 | RSS Board | validator.w3.org/feed |
|
| RSS 2.0 | RSS Board | validator.w3.org/feed |
|
||||||
| Microformats2 | microformats.org | indiewebify.me |
|
| Microformats2 | microformats.org | indiewebify.me |
|
||||||
| Micropub | micropub.spec.indieweb.org | micropub.rocks |
|
| Micropub | micropub.spec.indieweb.org | micropub.rocks |
|
||||||
| IndieAuth | indieauth.spec.indieweb.org | Manual testing |
|
| IndieAuth | www.w3.org/TR/indieauth | Manual testing |
|
||||||
| OAuth 2.0 | oauth.net/2 | Via IndieLogin |
|
| OAuth 2.0 | oauth.net/2 | Via IndieLogin |
|
||||||
|
|
||||||
All validators must pass before V1 release.
|
All validators must pass before V1 release.
|
||||||
@@ -215,7 +215,7 @@ All validators must pass before V1 release.
|
|||||||
|
|
||||||
### External Standards
|
### External Standards
|
||||||
- [Micropub Specification](https://micropub.spec.indieweb.org/)
|
- [Micropub Specification](https://micropub.spec.indieweb.org/)
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [Microformats2](http://microformats.org/wiki/microformats2)
|
- [Microformats2](http://microformats.org/wiki/microformats2)
|
||||||
- [RSS 2.0 Specification](https://www.rssboard.org/rss-specification)
|
- [RSS 2.0 Specification](https://www.rssboard.org/rss-specification)
|
||||||
- [IndieLogin API](https://indielogin.com/api)
|
- [IndieLogin API](https://indielogin.com/api)
|
||||||
|
|||||||
@@ -1573,7 +1573,7 @@ Final steps before V1 release.
|
|||||||
|
|
||||||
### External Standards
|
### External Standards
|
||||||
- [Micropub Specification](https://micropub.spec.indieweb.org/)
|
- [Micropub Specification](https://micropub.spec.indieweb.org/)
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [Microformats2](http://microformats.org/wiki/microformats2)
|
- [Microformats2](http://microformats.org/wiki/microformats2)
|
||||||
- [RSS 2.0 Specification](https://www.rssboard.org/rss-specification)
|
- [RSS 2.0 Specification](https://www.rssboard.org/rss-specification)
|
||||||
- [IndieLogin API](https://indielogin.com/api)
|
- [IndieLogin API](https://indielogin.com/api)
|
||||||
|
|||||||
@@ -323,7 +323,7 @@ Quick lookup for architectural decisions:
|
|||||||
|
|
||||||
### External Specs
|
### External Specs
|
||||||
- [Micropub Spec](https://micropub.spec.indieweb.org/)
|
- [Micropub Spec](https://micropub.spec.indieweb.org/)
|
||||||
- [IndieAuth Spec](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Spec](https://www.w3.org/TR/indieauth/)
|
||||||
- [Microformats2](http://microformats.org/wiki/microformats2)
|
- [Microformats2](http://microformats.org/wiki/microformats2)
|
||||||
- [RSS 2.0 Spec](https://www.rssboard.org/rss-specification)
|
- [RSS 2.0 Spec](https://www.rssboard.org/rss-specification)
|
||||||
|
|
||||||
|
|||||||
@@ -88,6 +88,6 @@ The v0.9.3 fix that added `grant_type` was based on an incorrect assumption that
|
|||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
- [IndieAuth Specification - Authentication](https://indieauth.spec.indieweb.org/#authentication)
|
- [IndieAuth Specification - Authentication](https://www.w3.org/TR/indieauth/#authentication)
|
||||||
- [IndieAuth Specification - Authorization Endpoint](https://indieauth.spec.indieweb.org/#authorization-endpoint)
|
- [IndieAuth Specification - Authorization Endpoint](https://www.w3.org/TR/indieauth/#authorization-endpoint)
|
||||||
- ADR-022: IndieAuth Authentication Endpoint Correction (if created)
|
- ADR-022: IndieAuth Authentication Endpoint Correction (if created)
|
||||||
|
|||||||
@@ -242,7 +242,7 @@ Implement **both** solutions for maximum compatibility:
|
|||||||
Should show the h-app div
|
Should show the h-app div
|
||||||
|
|
||||||
3. **Test with IndieAuth validator**:
|
3. **Test with IndieAuth validator**:
|
||||||
Use https://indieauth.spec.indieweb.org/validator or a similar tool
|
Use https://www.w3.org/TR/indieauth/validator or a similar tool
|
||||||
|
|
||||||
4. **Test actual auth flow**:
|
4. **Test actual auth flow**:
|
||||||
- Navigate to /admin/login
|
- Navigate to /admin/login
|
||||||
|
|||||||
@@ -337,7 +337,7 @@ This allows gradual migration without breaking existing integrations.
|
|||||||
- [IndieAuth Client Discovery Analysis Report](/home/phil/Projects/starpunk/docs/reports/indieauth-client-discovery-analysis.md)
|
- [IndieAuth Client Discovery Analysis Report](/home/phil/Projects/starpunk/docs/reports/indieauth-client-discovery-analysis.md)
|
||||||
|
|
||||||
### IndieWeb Standards
|
### IndieWeb Standards
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [Microformats2 h-app](https://microformats.org/wiki/h-app)
|
- [Microformats2 h-app](https://microformats.org/wiki/h-app)
|
||||||
- [IndieLogin.com](https://indielogin.com/)
|
- [IndieLogin.com](https://indielogin.com/)
|
||||||
|
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ The IndieAuth specification has evolved significantly:
|
|||||||
|
|
||||||
### 2. Current IndieAuth Specification Requirements
|
### 2. Current IndieAuth Specification Requirements
|
||||||
|
|
||||||
From [indieauth.spec.indieweb.org](https://indieauth.spec.indieweb.org/), Section 4.2:
|
From the [W3C IndieAuth Specification](https://www.w3.org/TR/indieauth/), Section 4.2:
|
||||||
|
|
||||||
> "Clients SHOULD publish a Client Identifier Metadata Document at their client_id URL to provide additional information about the client."
|
> "Clients SHOULD publish a Client Identifier Metadata Document at their client_id URL to provide additional information about the client."
|
||||||
|
|
||||||
@@ -429,7 +429,7 @@ Switch to self-hosted IndieAuth server or different provider
|
|||||||
|
|
||||||
## Related Documents
|
## Related Documents
|
||||||
|
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [OAuth Client ID Metadata Document](https://www.ietf.org/archive/id/draft-parecki-oauth-client-id-metadata-document-00.html)
|
- [OAuth Client ID Metadata Document](https://www.ietf.org/archive/id/draft-parecki-oauth-client-id-metadata-document-00.html)
|
||||||
- [RFC 3986 - URI Generic Syntax](https://www.rfc-editor.org/rfc/rfc3986)
|
- [RFC 3986 - URI Generic Syntax](https://www.rfc-editor.org/rfc/rfc3986)
|
||||||
- ADR-016: IndieAuth Client Discovery Mechanism
|
- ADR-016: IndieAuth Client Discovery Mechanism
|
||||||
|
|||||||
117
docs/reports/indieauth-spec-url-standardization-2025-11-24.md
Normal file
117
docs/reports/indieauth-spec-url-standardization-2025-11-24.md
Normal file
@@ -0,0 +1,117 @@
|
|||||||
|
# IndieAuth Specification URL Standardization Report
|
||||||
|
|
||||||
|
**Date**: 2025-11-24
|
||||||
|
**Task**: Validate and standardize IndieAuth specification references across all documentation
|
||||||
|
**Architect**: StarPunk Architect Subagent
|
||||||
|
|
||||||
|
## Executive Summary
|
||||||
|
|
||||||
|
Successfully standardized all IndieAuth specification references across the StarPunk codebase to use the official W3C version at https://www.w3.org/TR/indieauth/. This ensures consistency and points to the authoritative, maintained specification.
|
||||||
|
|
||||||
|
## Scope of Changes
|
||||||
|
|
||||||
|
### Files Updated: 28
|
||||||
|
|
||||||
|
The following categories of files were updated:
|
||||||
|
|
||||||
|
#### Core Documentation
|
||||||
|
- `/home/phil/Projects/starpunk/README.md` - Main project readme
|
||||||
|
- `/home/phil/Projects/starpunk/docs/examples/identity-page-customization-guide.md` - User guide
|
||||||
|
- `/home/phil/Projects/starpunk/docs/standards/testing-checklist.md` - Testing standards
|
||||||
|
|
||||||
|
#### Architecture Documentation
|
||||||
|
- `/home/phil/Projects/starpunk/docs/architecture/overview.md` - System architecture overview
|
||||||
|
- `/home/phil/Projects/starpunk/docs/architecture/indieauth-client-diagnosis.md` - Client diagnosis guide
|
||||||
|
- `/home/phil/Projects/starpunk/docs/architecture/indieauth-identity-page.md` - Identity page design
|
||||||
|
- `/home/phil/Projects/starpunk/docs/architecture/technology-stack.md` - Technology stack documentation
|
||||||
|
|
||||||
|
#### Architecture Decision Records (ADRs)
|
||||||
|
- ADR-005: IndieLogin Authentication
|
||||||
|
- ADR-010: Authentication Module Design
|
||||||
|
- ADR-016: IndieAuth Client Discovery
|
||||||
|
- ADR-017: OAuth Client Metadata Document
|
||||||
|
- ADR-018: IndieAuth Detailed Logging
|
||||||
|
- ADR-019: IndieAuth Correct Implementation
|
||||||
|
- ADR-021: IndieAuth Provider Strategy
|
||||||
|
- ADR-022: Auth Route Prefix Fix
|
||||||
|
- ADR-023: IndieAuth Client Identification
|
||||||
|
- ADR-024: Static Identity Page
|
||||||
|
- ADR-025: IndieAuth PKCE Authentication
|
||||||
|
- ADR-028: Micropub Implementation
|
||||||
|
- ADR-029: Micropub IndieAuth Integration
|
||||||
|
|
||||||
|
#### Project Planning
|
||||||
|
- `/home/phil/Projects/starpunk/docs/projectplan/v1/implementation-plan.md`
|
||||||
|
- `/home/phil/Projects/starpunk/docs/projectplan/v1/quick-reference.md`
|
||||||
|
- `/home/phil/Projects/starpunk/docs/projectplan/v1/README.md`
|
||||||
|
|
||||||
|
#### Design Documents
|
||||||
|
- `/home/phil/Projects/starpunk/docs/design/initial-files.md`
|
||||||
|
- `/home/phil/Projects/starpunk/docs/design/phase-3-authentication-implementation.md`
|
||||||
|
|
||||||
|
#### Reports
|
||||||
|
- Various implementation reports referencing IndieAuth specification
|
||||||
|
|
||||||
|
## Changes Made
|
||||||
|
|
||||||
|
### URL Replacements
|
||||||
|
- **Old URL**: `https://indieauth.spec.indieweb.org/`
|
||||||
|
- **New URL**: `https://www.w3.org/TR/indieauth/`
|
||||||
|
- **Total Replacements**: 42 references updated
|
||||||
|
|
||||||
|
### Why This Matters
|
||||||
|
|
||||||
|
1. **Authority**: The W3C version is the official, authoritative specification
|
||||||
|
2. **Maintenance**: W3C specifications receive regular updates and errata
|
||||||
|
3. **Permanence**: W3C URLs are guaranteed to be permanent and stable
|
||||||
|
4. **Standards Compliance**: Referencing W3C directly shows commitment to web standards
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
### Pre-Update Status
|
||||||
|
- Found 42 references to the old IndieAuth spec URL (`indieauth.spec.indieweb.org`)
|
||||||
|
- No references to the W3C version
|
||||||
|
|
||||||
|
### Post-Update Status
|
||||||
|
- 0 references to the old spec URL
|
||||||
|
- 42 references to the W3C version (`www.w3.org/TR/indieauth`)
|
||||||
|
- All documentation now consistently references the W3C specification
|
||||||
|
|
||||||
|
### Validation Command
|
||||||
|
```bash
|
||||||
|
# Check for any remaining old references
|
||||||
|
grep -r "indieauth\.spec\.indieweb\.org" /home/phil/Projects/starpunk --include="*.md" --include="*.py"
|
||||||
|
# Result: No matches found
|
||||||
|
|
||||||
|
# Count W3C references
|
||||||
|
grep -r "w3\.org/TR/indieauth" /home/phil/Projects/starpunk --include="*.md" --include="*.py" | wc -l
|
||||||
|
# Result: 42 references
|
||||||
|
```
|
||||||
|
|
||||||
|
## Impact Assessment
|
||||||
|
|
||||||
|
### Positive Impacts
|
||||||
|
1. **Documentation Consistency**: All documentation now points to the same authoritative source
|
||||||
|
2. **Future-Proofing**: W3C URLs are permanent and will not change
|
||||||
|
3. **Professional Standards**: Demonstrates commitment to official web standards
|
||||||
|
4. **Improved Credibility**: References to W3C specifications carry more weight
|
||||||
|
|
||||||
|
### No Negative Impacts
|
||||||
|
- No functional changes to code
|
||||||
|
- No breaking changes to existing functionality
|
||||||
|
- URLs redirect properly, so existing bookmarks still work
|
||||||
|
- All section references remain valid
|
||||||
|
|
||||||
|
## Recommendations
|
||||||
|
|
||||||
|
1. **Documentation Standards**: Add a documentation standard requiring all specification references to use official W3C URLs where available
|
||||||
|
2. **CI/CD Check**: Consider adding a check to prevent introduction of old spec URLs
|
||||||
|
3. **Regular Review**: Periodically review external references to ensure they remain current
|
||||||
|
|
||||||
|
## Conclusion
|
||||||
|
|
||||||
|
Successfully completed standardization of all IndieAuth specification references across the StarPunk documentation. All 42 references have been updated from the old IndieWeb.org URL to the official W3C specification URL. This ensures the project documentation remains consistent, professional, and aligned with web standards best practices.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Note**: This report documents an architectural documentation update. No code changes were required as Python source files did not contain direct specification URLs in comments.
|
||||||
@@ -314,9 +314,9 @@ This client_id is not registered (https://starpunk.thesatelliteoflove.com)
|
|||||||
## Standards References
|
## Standards References
|
||||||
|
|
||||||
### IndieAuth
|
### IndieAuth
|
||||||
- [IndieAuth Specification](https://indieauth.spec.indieweb.org/)
|
- [IndieAuth Specification](https://www.w3.org/TR/indieauth/)
|
||||||
- [Client Information Discovery](https://indieauth.spec.indieweb.org/#client-information-discovery)
|
- [Client Information Discovery](https://www.w3.org/TR/indieauth/#client-information-discovery)
|
||||||
- [Section 4.2](https://indieauth.spec.indieweb.org/#client-information-discovery)
|
- [Section 4.2](https://www.w3.org/TR/indieauth/#client-information-discovery)
|
||||||
|
|
||||||
### OAuth
|
### OAuth
|
||||||
- [OAuth Client ID Metadata Document](https://www.ietf.org/archive/id/draft-parecki-oauth-client-id-metadata-document-00.html)
|
- [OAuth Client ID Metadata Document](https://www.ietf.org/archive/id/draft-parecki-oauth-client-id-metadata-document-00.html)
|
||||||
|
|||||||
@@ -63,7 +63,7 @@ This document provides a comprehensive checklist for testing StarPunk functional
|
|||||||
### Specifications
|
### Specifications
|
||||||
- IndieWeb Notes: https://indieweb.org/note
|
- IndieWeb Notes: https://indieweb.org/note
|
||||||
- Micropub Spec: https://micropub.spec.indieweb.org
|
- Micropub Spec: https://micropub.spec.indieweb.org
|
||||||
- IndieAuth Spec: https://indieauth.spec.indieweb.org
|
- IndieAuth Spec: https://www.w3.org/TR/indieauth/
|
||||||
- Microformats2: http://microformats.org/wiki/h-entry
|
- Microformats2: http://microformats.org/wiki/h-entry
|
||||||
- RSS 2.0 Spec: https://www.rssboard.org/rss-specification
|
- RSS 2.0 Spec: https://www.rssboard.org/rss-specification
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user