docs: fix the dead links to the sample plugin and the stale apiVersion rules - #7
Merged
Merged
Conversation
…n rules The README pointed at com.glyph.hello-status/, a path that does not exist: the sample plugin lives under plugins/. The docs-site link was also buried under "Plugin API" near the bottom; it now sits in the second line with the per-page links next to it. Four places still described apiVersion as an exact match against a hardcoded "current" version, which the compatibility window replaced. The host accepts anything from PLUGIN_API_COMPAT_FLOOR (0.16.0) up to the running app version, and PLUGIN_API_VERSION is the app version rather than a hand-pinned 0.17.0, so the ecosystem "version flow" section was wrong about which of the two numbers is maintained by hand. Also refreshed the README field table, which predated sha256, category, sandbox, permissions, keywords, and official, and still showed a caret apiVersion that the 0.x policy rejects. The publishing section told authors to edit index.json, which CONTRIBUTING and CI both forbid: registrations go in plugins/<id>/plugin.json and the index is generated on merge.
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
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.
Summary
The published docs site read as if it did not exist: several links from the README and the docs 404'd, and the site link itself was buried near the bottom of the README. Separately, the
apiVersionrules in four places still described the exact-match policy that the compatibility window replaced.This PR is docs and schema descriptions only. The site's own layout is fixed in #5, which this stacks cleanly on top of (no overlapping files).
Dead links
com.glyph.hello-status/404'd from the README on GitHub too: the sample plugin lives underplugins/. Nowplugins/com.glyph.hello-status/README.md.Verified afterwards that every relative link in
README.md,CONTRIBUTING.md,docs/*.md, andplugins/*/README.mdresolves to a real path.apiVersion
The host loads anything from
PLUGIN_API_COMPAT_FLOOR(0.16.0) up to the running app version.PLUGIN_API_VERSIONis__APP_VERSION__, so it moves on every release and is never hand-edited; the floor is the one hand-maintained number. Four places still said "exact match required until 1.0 (currently0.17.0)":CONTRIBUTING.mdentry rulesdocs/getting-started.mdmanifest tableindex.schema.jsonandplugin.schema.jsonfield descriptionsdocs/ecosystem.mdalso claimedPLUGIN_API_VERSIONis "pinned at0.17.0, bumped by hand", which named the wrong constant. Its "Version flow" list now covers both numbers.README accuracy
sha256,category,sandbox,permissions,keywords, andofficial, and the JSON sample showed"apiVersion": "^1.0.0", which the 0.x policy rejects and which the schema pattern would accept only to have the host refuse it.index.json.CONTRIBUTING.mdand the validate workflow both forbid that: registrations go inplugins/<id>/plugin.jsonand the index is generated on merge.Testing
node scripts/build-index.mjsproduces no drift, so no generated file is touched.Not included
docs/api-reference.mdis still titled "(0.17.0)" and the template'stypes/glyph.d.tsheader still says0.17.0, while the host API is at0.20.0. Bumping those markers means asserting the 0.18 to 0.20 surface is documented, which needs a real audit rather than a find and replace.