docs: LWS / CID v1 compatibility doc + README bullet (#394)#395
Merged
Conversation
JSS pod profiles became structurally W3C Controlled Identifier documents in 0.0.174 (#388, Phase A of #386). Capture that honestly in two places: 1. README — one-line bullet under Features pointing at the new doc and the W3C specs. 2. docs/lws.md — skeleton page with the three-level compatibility model (profile shape ✅ / keys ❌ / verifier ❌), what Phase A actually does (with a sample profile JSON-LD), what Phase B (the standalone "doctor / add-keys" app) will add, what Phase 3 (the server-side LWS-CID JWT verifier) will add, and spec references. Companion docs-site page (Docusaurus at jss.live/docs/features/lws) will land in a separate PR against the docs repo.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #394 (JSS-repo half).
Summary
docs/lws.md— skeleton page documenting the three-level compatibility model honestly:Why now
Phase A landed and is live on solid.social + melvin.me. Anyone hitting a JSS-served WebID gets a W3C Controlled Identifier-shaped document. That's worth documenting, but only in a way that doesn't overpromise — the verifier and the keys aren't there yet. The doc is structured so it can be fleshed out as Phase B and the verifier ship.
Companion
Docusaurus page at jss.live/docs/features/lws will follow as a separate PR against the docs repo.
Refs