docs: point the README at the published documentation site - #60
Merged
Conversation
The API reference, the guide and the migration guide are now served at https://vscode-ext-kit.kkdev92.dev/, built from the tag that npm resolves as `latest`, so the site and the package cannot disagree about what an export looks like. The README now says where to read them, and the entry under Known Limitations that said the reference was generated but not published is gone, because it no longer describes anything. Two claims that named an exact patch version are rewritten to name the line instead. `4.1.0 is the current release` and `4.1.0 ... holds latest on npm` were both true when written and false one release later; naming `4.1` and `4.x` says the same thing without going stale every patch. The npm badge already carries the exact version. Verified: every URL added here returns 200, and the claim that `1.134.0` is the newest `@types/vscode` still holds against the registry. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013Tfbt5Vy1jB9C6mMAHXhLY
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.
The documentation set is now served at https://vscode-ext-kit.kkdev92.dev/.
This says so in the README, and removes the entry that said it was not.
Why
Known Limitations carried "No hosted API reference yet — it is generated from
the JSDoc but not published". That is no longer true, and a limitation that
has been lifted is worse than no limitation at all: it tells a reader to go
looking for something that is right there.
The site is built from the tag that npm resolves as
latest, so the reference areader sees and the package they install cannot describe different exports.
Two claims that were going stale every release
The README named an exact patch version twice:
`4.1.0` is the current release`4.1.0` is the current release and holds `latest` on npmBoth were true when written and false one release later —
4.1.1shipped andneither was updated. They now name the line (
4.1,4.x), which says the samething and stops going stale on every patch. The npm badge at the top already
carries the exact version, and carries it automatically.
Verification
assumed: the front page, and the guide, migration guide and changelog pages it
links to
1.134.0is the newest@types/vscodewasre-checked against the registry and still holds
No package content changes: this touches
README.mdandCHANGELOG.mdonly.🤖 Generated with Claude Code