Uh oh!
There was an error while loading. Please reload this page.
Adopt docs-2026.2, and take the language service's examples from it - #5
Merged
Conversation
Closes T015. The two TypeScript examples on the language service page were authored here, where nothing checks them: this repository checks Python with pyright, and the one TypeScript tree it does check, docs/snippets/js/, is vendored byte for byte from a docs-YYYY.N release of idfkit-js and is never hand-edited. A rename in @idfkit/language would have left the published page showing code that compiles in nobody's checkout, and a reader would have found out first. They now come from the release, like every other TypeScript example on the site. idfkit-js#43 moved them into docs-snippets/, where tsconfig.docs.json compiles them against the published surface; docs-2026.2 ships them. The page's eight include paths move from docs/snippets/explanation/ to docs/snippets/js/explanation/idf-language-service/, and the hand-authored copies are deleted rather than left to rot beside the checked ones. Verified rather than assumed: all four regions each file needs are present in the vendored copy, the strict build renders eight code blocks and none of them is empty, and sync_js_artifacts.py --check confirms the tree matches docs-2026.2. Also arriving with the newer artifact: docs/snippets/js/explanation/ two-writers-one-model/controls.ts, added to idfkit-js after docs-2026.1, and a refreshed typedoc.json. Both are what pinning one tag for the reference and the examples together is for, so the two always describe the same commit. [tool.idfkit.docs] moves to docs-2026.2. The conformance, governance and library levels do not.
Contributor
Docs preview for this PR is available at: Changed pages: |
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.
Closes T015.
The gap
The two TypeScript examples on the language service page were authored here, where nothing checks them. This repository checks Python with pyright, and the one TypeScript tree it does check,
docs/snippets/js/, is vendored byte for byte from adocs-YYYY.Nrelease of idfkit-js and is never hand-edited.So a rename in
@idfkit/languagewould have left the published page showing code that compiles in nobody's checkout, and a reader would have found out first.What changes
idfkit-js#43 moved them into
docs-snippets/, wheretsconfig.docs.jsoncompiles them against the published surface rather than the sources.docs-2026.2ships them. This vendors that release and repoints the page's eight includes:The hand-authored copies are deleted rather than left to rot beside the checked ones.
Verified, not assumed
sync_js_artifacts.py --checkconfirms the tree matchesdocs-2026.2.check_page_kinds.pyandcheck_capability_declarations.pyboth pass.Also in this diff
docs/snippets/js/explanation/two-writers-one-model/controls.ts, added to idfkit-js afterdocs-2026.1, and a refreshedtypedoc.json. Both arrive because the reference and the examples are pinned on one tag, so they always describe the same commit.Levels
[tool.idfkit.docs]moves todocs-2026.2. The conformance, governance and library levels do not.Pre-existing, unrelated
make checkis red onmaintoo:ruffreportsS310inscripts/sync_js_artifacts.py, untouched here. And[tool.idfkit.library]is still0.15.0, which lacks names its own merged pages document.