Repository navigation
Template 0.1.35: user docs fixed after a review of the website - #59
Merged
Merged
Conversation
The website publishes .tools/docs as its guides; a review on 2026-11-17 found these errors, fixed here: - install.md gets an "Uninstall an app" section (Windows: Installed apps or Uninstall-<AppName>.exe; macOS and Linux: uninstall.sh in the install folder, which removes the shortcut, unregisters the tools and deletes the folder). The update steps and troubleshooting_installed_app.md link to it instead of the download_executable.md stub. - tools_bridge.md links "Writing tools" to the website's guide (/guides/writing-tools/) instead of AUTHORING.md on GitHub. - notebook_usage.md: applications menu on Linux, not the Start Menu. - use_cases.md links to the App Centre instead of its own list of apps. - notebook_upload.md: the version-check cell is fenced as python. - Headings in sentence case, without emoji or trailing colons (code_hiding, before_getting_started, executable_creation, workflow_status, installer_images). No page links to the old anchors. Migration 0.1.34 -> 0.1.35 delivers it: use_cases.md is replaced only when it is the 0.1.34 template file, the other pages get exact-text edits, customised passages are SKIPPED, line endings are kept. Design note migration_0_1_35.md, tests, and before_0_1_35 chained into the older test helpers (0.1.32 and 0.1.18 tests compare with the files as their version left them). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
A review of LabConstrictor-Site on 2026-11-17 found errors in the template's
.tools/docs, which the Site publishes as guides. Fixed here, at the source:install.mdgets an "Uninstall an app" section: Windows via Settings > Apps > Installed apps orUninstall-<AppName>.exein the install folder; macOS and Linux viabash <install folder>/uninstall.sh(taken fromconstruct.yaml,uninstall.sh,pre_uninstall.shandpost_install.bat). The update steps andtroubleshooting_installed_app.mdlink to it instead of thedownload_executable.mdstub.tools_bridge.mdlinks to the Site guide/guides/writing-tools/instead ofAUTHORING.mdon GitHub (both places).notebook_usage.mdsays "applications menu (Linux)", as the Site's/guides/using-apps/does.use_cases.mdlinks to the App Centre instead of keeping its own list (it listed only VLab4Mic).notebook_upload.mdis markedpython.code_hiding.md; sentence case, no emoji, no trailing colons inbefore_getting_started.md,executable_creation.md,workflow_status.mdandinstaller_images.md. No page in this repository or in LabConstrictor-Site links to the old anchors.Shipped as template 0.1.35. The migration replaces
use_cases.mdonly when it is the 0.1.34 file, makes exact-text edits elsewhere, and SKIPS customised passages. It keeps line endings. The design note ismigration_0_1_35.md. The 0.1.32 and 0.1.18 tests now compare against the files as their own version left them, viabefore_0_1_35.Checks: ruff and mypy are clean. Locally on Windows, pytest gives 443 passed and 55 failed. The same 55 tests fail on a clean checkout of
main: they run bash scripts. No new failures. CI runs on Ubuntu.🤖 Generated with Claude Code