Repository navigation
Docs: separate the widget walkthrough from the reference - #2
Merged
Merged
Conversation
widgets.md interleaved a three-step tutorial with lookup material, so reading it start to finish meant paging through field-type and ctx tables, and looking up ctx.fail meant scrolling past the walkthrough. The walkthrough now runs uninterrupted from the folder layout to the checklist, and every reference section sits below it under three headings. Each step links to the reference that expands it. No prose changed and every existing heading kept its text, so all anchors, including widgets.md#reporting-a-failure, still resolve.
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
docs/widgets.mdso the three-step walkthrough runs uninterrupted (folder structure, manifest,data.js,index.html, cache-busting, checklist), followed by a# Referencehalf.Reference: the manifest,Reference: data.jsandReference: the frontend, leavingToolbox (optional)as its own section.Testing
All green, including the 4 tests in
ui/test/widget-docs.test.mjsthat pin the iframe parameter table, canvas sizes and CSP by value. Verified separately that all 10 internal anchors resolve and thatdocs/api-errors.md's inboundwidgets.md#reporting-a-failurelink still points at a real heading.Checklist