docs: web-tools landing page, changelog, experiment-designer quickstart#80
Draft
mbreiser wants to merge 1 commit into
Draft
docs: web-tools landing page, changelog, experiment-designer quickstart#80mbreiser wants to merge 1 commit into
mbreiser wants to merge 1 commit into
Conversation
Three unified-site publishing follow-ups from PR #61: 1. Replace README.md as the unified-site section parent with a new docs/web-tools.md. Strip Just-the-Docs front matter from README.md (READMEs are GitHub-repo landing pages only, per @floesche's guidance in maDisplayTools/pull/24). The new docs/web-tools.md has the same front matter (title: Web Tools, parent: Generation 6, has_children: true, nav_order: 11) and a concise tool-listing body without the dev/CI content that belongs on the GitHub README only. 2. Add docs/experiment-designer-quickstart.md stub (nav_order: 2) that links to the existing styled HTML page at its GitHub Pages URL. The HTML is 432 lines of custom CSS and numbered step cards that would lose all meaning if flattened to Markdown, and the page already works as a standalone at https://reiserlab.github.io/webDisplayTools/experiment_designer_quickstart.html. Option (c) — stub linking to the styled page — preserves it without duplication. 3. Add Just-the-Docs front matter to CHANGELOG.md (title: Changelog, parent: Web Tools, grand_parent: Generation 6, nav_order: 90). Frank's repo-only-READMEs philosophy does not apply to release-notes files; the changelog is user-facing content appropriate for the unified site.
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
2 participants
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.
Follow-up to PR #61 (and commit 6cf7ddb). Addresses the three deferred unified-site publishing items.
What changed
1. Replace
README.mdas the "Web Tools" section parent → newdocs/web-tools.mdPer @floesche's guidance in maDisplayTools/pull/24, READMEs should be the GitHub-repo landing page only, not the unified-site section parent. We applied this to maDisplayTools already (commit a51fe18); doing the same here.
docs/web-tools.md— carries the Just-the-Docs front matter (title: Web Tools,parent: Generation 6,has_children: true,nav_order: 11) and a concise tool-listing body. Omits the dev/CI/repo-structure sections from the README, which belong on the GitHub README only.README.mdso it is no longer picked up as a unified-site page.2.
docs/experiment-designer-quickstart.mdstub (nav_order: 2)The source file
experiment_designer_quickstart.htmlis 432 lines of custom CSS + numbered step-card layout. Converting to Markdown (option a) would lose all the visual structure. Injecting Jekyll front matter into the HTML (option b) risks CSS conflicts with the site theme.Chose option (c): a small stub MD page that describes the guide and links directly to the standalone HTML at its GitHub Pages URL (
https://reiserlab.github.io/webDisplayTools/experiment_designer_quickstart.html). This preserves the styled version without content duplication.3. Just-the-Docs front matter added to
CHANGELOG.mdFrank's "READMEs stay repo-only" guidance doesn't apply to release notes. The changelog is user-facing content appropriate for the unified site. Added:
Changeset
Verification
git diff main...HEAD --statshows exactly these 4 files, no stray changes.PATTERN_EDITOR_QUICKSTART.mdalready hasparent: Web Tools, grand_parent: Generation 6— it will continue to resolve correctly oncedocs/web-tools.mdis the "Web Tools" parent.docs/experiment-designer-quickstart.mdusesnav_order: 2(after the Pattern Editor quickstart atnav_order: 1)./cc @mbreiser for review
Generated by Claude Code