Add site search, refresh docs, add preview build workflow#19
Merged
Conversation
- Add Simple-Jekyll-Search: /search/ page, search.json index, and a Search link with magnifying-glass icon in the top nav - Restructure walkthroughs.md into numbered sections with consistent tables so the new sticky TOC and search index work cleanly - Refresh setup.md with a requirements table and troubleshooting matrix - Add a "What's new" log to the home page and fix the broken /repositories.md link - Disable the author sidebar and enable a sticky TOC on landing pages (walkthroughs, setup, repositories, objectoriented, batch, tutorials) - Switch analytics provider to false (it was loading the include with no tracking ID) and document how to enable it + Search Console - Remove unreferenced files: _config copy.yml, _pages/about_bak.md (had a duplicate permalink: / that silently conflicted with about.md), and _pages/OLD_archive - Add .github/workflows/preview-build.yml so non-master branches build to a downloadable artifact for review without affecting the live site Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The github-pages gem needs the owner/repo when running outside the official GitHub Pages builder; without it the build fails with "No repo name found". Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The committed _config.yml hard-codes url: https://canlab.github.io, which caused nav links in the preview build to bounce to the live site. The new _config.preview.yml override clears url and baseurl so the artifact works correctly when served from any local web server (e.g. python3 -m http.server). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Uses the Minimal Mistakes theme's sidebar front-matter so the update log sits alongside the author profile instead of breaking the main reading flow. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The old 404 page referenced linkhelp.clients.google.com, a Google service that has been deprecated for years (the script tag itself returns 404). Replaced with an embedded search box backed by the new search.json index plus links to common destinations. objectoriented.md previously duplicated the home-page intro and linked to the broken /repositories.md path. Tightened the prose, fixed the link, and removed a redundant install-link paragraph that pointed to material the home page already covers. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Two issues found while previewing: 1. The search script was loaded from unpkg.com. When the CDN is blocked, slow, or unreachable (e.g. when previewing offline) the script never loads and the search silently fails. Bundle a local copy under assets/js/ so it works regardless of network state. 2. about.md and setup.md linked to /canlab_help_1_installing_tools/... but Jekyll actually serves those files under /_pages/. The links have been broken on the live site too. Updated to /_pages/... Co-Authored-By: Claude Opus 4.7 <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
1 participant
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.
Summary
/search/page,search.jsonindex, and a magnifying-glass nav link. The library is bundled locally so it works offline.walkthroughs.mdinto numbered sections with consistent tables and a sticky TOC; rewrotesetup.mdwith a requirements table and troubleshooting matrix; tightenedobjectoriented.md; added a "What's new" log to the home-page sidebar._config copy.yml,_pages/about_bak.md(silent permalink conflict), and_pages/OLD_archive/(28 files); fixed broken/_pages/...link prefix on home and setup pages.false(it was loading the include with no tracking ID and silently doing nothing); added doc comments for re-enabling analytics + Search Console..github/workflows/preview-build.ymlbuilds every non-master branch into a downloadable artifact with localhost-friendly URLs, so future PRs can be reviewed visually without touching the live site.Test plan
masterafter merge and confirmhttps://canlab.github.io/search/loads and returns resultshttps://canlab.github.io/walkthroughs/and spot-check links from each numbered sectionhttps://canlab.github.io/setup/; confirm the requirements table and troubleshooting matrix renderhttps://canlab.github.io/does-not-exist) and confirm the in-page search worksDocumented for follow-up
https://canlab.github.io/sitemap.xmlto Google Search Consolelycheeverse/lychee-action) to the preview workflow once the existing site is clean🤖 Generated with Claude Code