Skip to content

Template 0.1.35: user docs fixed after a review of the website - #59

Merged
IvanHCenalmor merged 1 commit into
mainfrom
claude/docs-site-review-fixes
Nov 17, 2026
Merged

IvanHCenalmor merged 1 commit into
mainfrom
claude/docs-site-review-fixes

Conversation

@IvanHCenalmor

Copy link
Copy Markdown
Collaborator

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:

  • Uninstall steps. install.md gets an "Uninstall an app" section: Windows via Settings > Apps > Installed apps or Uninstall-<AppName>.exe in the install folder; macOS and Linux via bash <install folder>/uninstall.sh (taken from construct.yaml, uninstall.sh, pre_uninstall.sh and post_install.bat). The update steps and troubleshooting_installed_app.md link to it instead of the download_executable.md stub.
  • Writing tools. tools_bridge.md links to the Site guide /guides/writing-tools/ instead of AUTHORING.md on GitHub (both places).
  • Linux menu. notebook_usage.md says "applications menu (Linux)", as the Site's /guides/using-apps/ does.
  • App list. use_cases.md links to the App Centre instead of keeping its own list (it listed only VLab4Mic).
  • Code fence. The long cell in notebook_upload.md is marked python.
  • Heading style. "Who is this for?" in code_hiding.md; sentence case, no emoji, no trailing colons in before_getting_started.md, executable_creation.md, workflow_status.md and installer_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.md only when it is the 0.1.34 file, makes exact-text edits elsewhere, and SKIPS customised passages. It keeps line endings. The design note is migration_0_1_35.md. The 0.1.32 and 0.1.18 tests now compare against the files as their own version left them, via before_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

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant