Repository navigation
Document unified example authoring and working editor schema - #5801
Closed
Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Closed
Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Conversation
commit: |
Contributor
|
No changes needing a change description found. |
Contributor
📦 Package size report1 package changed size, +1.89 KB (+0.0%) packed overall.
13 package(s) with no notable change
Packed = gzipped |
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.
Contributors currently get a 404 from the advertised editor schema and lack a single guide for creating, changing, versioning, and migrating unified examples.
Use the version-pinned JSON Schema artifact that is already published in the npm package, with a YAML language-server modeline. Centralized guidance explains operation keys, filename IDs versus title-based lineages,
since, generated artifacts, migration round-trip checks, editor support, and validation guarantees. Commands are explicitly qualified by installed CLI capabilities so examples 0.2.1 users are not told that unreleased commands are available.Fixes #5794.
Documentation-only, targeting
main. Package fixes remain in release-targeted PRs #5799 and #5800.