Skip to content

Docs: Connect-track pages corrected and tightened; GitHub Pages becomes redirects to the website - #168

Merged
guijacquemet merged 16 commits into
mainfrom
claude/stardist-labconstrictor-plan-aizdd6
Nov 18, 2026
Merged

guijacquemet merged 16 commits into
mainfrom
claude/stardist-labconstrictor-plan-aizdd6

Conversation

@guijacquemet

@guijacquemet guijacquemet commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

The LabConstrictor website now publishes these pages in its three tracks (Use / Build / Connect an app). This pass makes them correct, useful and readable; removes history, spec section numbers, decision dates and other working notes; and retires this repository's separate docs site.

Page Words Main changes
PROTOCOL.md 6214 → 4807 History, spec numbers, the sandbox app table (moved to TESTING.md) and a placeholder row for a feature that does not exist removed. Rules grouped by subject. Every rule, message and linked anchor kept.
AUTHORING.md 2595 → 2328 Title "Writing tools". Per-host detail moved to the host pages. Links to the site.
MANIFEST.md 1274 → 1217 Title "Tool markers". The hosts / host_requirements keys of labconstrictor-app.yaml set apart as not tool markers.
HOST_FEATURES.md 1747 → 1482 Per-app list (a duplicate of REPOSITORIES), test-case IDs and "Tested by" removed. New section on shared host behaviour.
OPERATIONS.md 2616 → 2021 Logs and troubleshooting first, releases last. Dated test notes and history removed.
REPOSITORIES.md 899 → 634 One table of apps and hosts. The "Latest release" column, which kept going stale, removed.
INSTALL, LABCONSTRICTOR_INTEGRATION, PUBLISHING, user-guide, CAPABILITIES small Tightened; links to site pages.
AGENTS.md All 11 published pages with their track and address. Relative links are fine (the site resolves them).

Second pass, after two external audits:

  • user-guide: "Check everything" checks the computer and the installation, not the plugins. To check a plugin, run Feature tour in that program (links to the three plugin guides). Also "the QuPath extension", in plain words.
  • AUTHORING:
    • One layout throughout: src/my_app_lc_tools/__init__.py, with every command using --pythonpath src.
    • The example output is Name("blurred"), so the tests.json example passes.
    • src/ is bundled automatically (no extra_files step).
    • Every command was checked by a real run.
  • init (code): for a package's __init__.py, init now creates the folder and prints --module <package> --pythonpath <src>. Before, it printed --module __init__. New test test_init_of_a_package_prints_the_package_and_src.
  • CAPABILITIES: no version line; only the napari, Fiji and QuPath columns. The notebook and command-line cells and the full operating-system table moved to HOST_FEATURES.
  • PUBLISHING: only today's install routes. The untested channels and "to decide" lists moved to TESTING.md ("Open items: publishing channels").
  • OPERATIONS: "Automated workflows never create tags" (test_versions.py pinned the old sentence). A line before the support-bundle command says to look through a bundle before sharing it.
  • INSTALL: separate commands for Windows and for macOS/Linux.

GitHub Pages: redirects instead of a second docs site.

  • scripts/build_redirect_site.py writes one page per address of the old site (https://cellmigrationlab.github.io/LabConstrictor-Tools/<PAGE>/). Each leads to the page's home on the website and keeps a #section (checked in Chromium).
  • Maintainers' pages (TESTING, REGRESSION_LEDGER, SPEC_WRONG_SCIENCE, CONFORMANCE) lead to the file on GitHub. The home page and the 404 page lead to /connect/.
  • A docs page with no destination fails the build.
  • docs.yml runs the script. mkdocs.yml, overrides/ and requirements-docs.txt are removed. Test: tests/test_redirect_site.py.
  • The redirects go live when this is merged (the workflow deploys from main).

Factual errors fixed:

  • LABCONSTRICTOR_INTEGRATION:
    • The pin was given as v0.3.0-alpha.2; the template pins alpha.4, and the page now names LC_TOOLS_PIN.
    • Tools is installed before the import check, not after (post_install.sh 74-89).
    • pre_uninstall warns and names the files to delete, rather than ignoring errors.
  • AUTHORING: a message does reach the Fiji Log window (LabConstrictor_Tools.groovy:2185). QuPath shows an affine's matrix rather than applying it.
  • REPOSITORIES: StarDist2D has 7 tools.
  • run --out: the help said "default: a temporary one"; the default is a new folder under <LC_HOME>/results.

Tests: the full suite was run on the branch and on main in this container. The only extra failure is test_installed_metadata_matches_the_source: the installed package is 0.3.0a1 and the source is 0.3.0a4, which is the container, not this change. Every test that reads docs passes, and so do test_redirect_site and the init tests.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP

Remove history, spec section numbers and the release-sandbox matrix (in
TESTING.md), group the rules by subject, keep every rule and exact sentence.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
Drop the time estimate from the title, link the site pages, fix host
claims (Fiji logs a message, QuPath only shows an affine), and move
per-host detail to the host pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
MANIFEST.md is now "Tool markers", with the app-manifest keys clearly
apart; HOST_FEATURES.md drops the duplicated app matrix and test notes;
INSTALL.md is shorter. Links point to the anchors that moved.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
Logs and troubleshooting first, releases last; drop dated test notes,
history and the Playground rule (in TESTING.md); keep every limit.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
Fix the registration steps against the template scripts (Tools is
installed before the import check; the pin was stale; pre_uninstall warns
when the entry stays), drop open questions and history, add StarDist2D's
tool count and one listing table.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
Link the site pages instead of the maintainers' docs site, drop internal
measurements and hedges, say that Check everything is a tool to run.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
The site now publishes the Connect-track pages and resolves relative
links. This repository's docs site is for maintainers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
…ME>/results)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
…cond docs site

Every address of the old docs site (/<PAGE>/) leads to the page's home on the website, keeping a #section; maintainers' pages lead to
the file on GitHub. scripts/build_redirect_site.py builds them (a docs page without a destination fails the build); mkdocs.yml,
overrides/ and requirements-docs.txt are removed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
@guijacquemet guijacquemet changed the title Docs: pages for the website's "Connect an app" track, corrected and tightened Docs: Connect-track pages corrected and tightened; GitHub Pages becomes redirects to the website Nov 18, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
…ecks a plugin; plain words

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
…npath src, a tests.json that passes, src/ bundled automatically

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
…book, command line, transport and test coverage move to host-features

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
…stions move to TESTING.md; Operations: automated workflows never tag, check a support bundle before sharing it

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
…ckage module and its src folder

The docs no longer tell readers to ignore what init prints.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
@guijacquemet
guijacquemet merged commit 9f92fe5 into main Nov 18, 2026
8 checks passed
@guijacquemet
guijacquemet deleted the claude/stardist-labconstrictor-plan-aizdd6 branch November 18, 2026 19:10
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.

2 participants