Repository navigation
Point the in-app Help page at the CookDex docs site - #145
Merged
Merged
Conversation
The Help page carried a third copy of the user docs (places, setup guides, job guides, FAQ, troubleshooting) in web/src/constants.js. Replace it with a short intro per topic and links to the matching page on https://knownframe.com/cookdex/docs/, keeping the first-run steps, the diagnostics report and "Open a GitHub issue" in the app. - Help and About get a Documentation link (also in aboutMeta.links.docs). - Each job's sheet in Tools links to its section of the task reference; a test keeps that map in step with the task registry. - Remove GET /help/docs. It read docs/ files the Docker image excludes, so it always returned nothing, and no page called it. - The smoke test checks the docs links instead of the old accordions. Closes #143 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…n-90b46a # Conflicts: # docs/TASKS.md
…cs site Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Merged
thekannen
added a commit
that referenced
this pull request
Oct 20, 2026
* Point the in-app Help page at the CookDex docs site (#145) * Point the in-app Help page at the CookDex docs site The Help page carried a third copy of the user docs (places, setup guides, job guides, FAQ, troubleshooting) in web/src/constants.js. Replace it with a short intro per topic and links to the matching page on https://knownframe.com/cookdex/docs/, keeping the first-run steps, the diagnostics report and "Open a GitHub issue" in the app. - Help and About get a Documentation link (also in aboutMeta.links.docs). - Each job's sheet in Tools links to its section of the task reference; a test keeps that map in step with the task registry. - Remove GET /help/docs. It read docs/ files the Docker image excludes, so it always returned nothing, and no page called it. - The smoke test checks the docs links instead of the old accordions. Closes #143 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Screenshots for the pull request (removed in the next commit) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Remove the pull request screenshots Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Say in AGENTS.md and CONTRIBUTING.md that in-app help links to the docs site Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> * Fixes for 2026.9.2: OpenAI-compatible endpoints, and issues found in a live run (#146) * Bump source-map-js in /web in the npm_and_yarn group across 1 directory (#135) Bumps the npm_and_yarn group with 1 update in the /web directory: [source-map-js](https://github.com/7rulnik/source-map-js). Updates `source-map-js` from 1.2.1 to 1.2.2 - [Release notes](https://github.com/7rulnik/source-map-js/releases) - [Changelog](https://github.com/7rulnik/source-map-js/blob/main/CHANGELOG.md) - [Commits](7rulnik/source-map-js@v1.2.1...v1.2.2) --- updated-dependencies: - dependency-name: source-map-js dependency-version: 1.2.2 dependency-type: indirect dependency-group: npm_and_yarn ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Honor OpenAI-compatible endpoints, and two Discover/name fixes - Settings gains OPENAI_BASE_URL (AI > More). Test and Load models call it instead of api.openai.com, and as a catalog key it now reaches jobs started from the web UI, including when set on the container (#140). - Discover counts a per-URL timeout toward the retry limit, so a page that always times out is set aside (#127). - Shouted-name detection works in any script, not only A-Z (#127). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Fixes from a live run against a 12k-recipe library - Live name cleanup skips renames to a name another recipe has; Mealie rejects them ("Recipe already exists") whatever slug is sent, which failed the whole job (#127). - Mealie backup wait defaults to 30 minutes (a 12k library took 14). - The Library's missing-servings finding drops "Fill in": the yield job can't fill recipes with no servings or yield text at all. - No flash of the sign-in form while the session check runs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Show why a rename was skipped, count name-taken skips, relabel backup keep Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> * Release 2026.9.2 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.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.
Closes #143.
The in-app Help page was a third copy of the user docs. It now gives a short intro per topic and links to the matching page on https://knownframe.com/cookdex/docs/, so the site is the one place user docs live.
What changed
Help page (HelpPage.jsx, constants.js).
HELP_PLACES,HELP_SETUP_GUIDES,HELP_TASK_GUIDES,HELP_FAQandHELP_TROUBLESHOOTINGare gone, about 340 lines. In their place:a Documentation card linking to the docs home;
First steps, a short checklist kept in the app (see below), with a link to Getting started;
one card per topic, each with one sentence and its links:
getting-started/#where-things-areinstall/,getting-started/#sign-in-and-connect-mealie,database-connection/tasks/,tasks/data-maintenance/,tasks/backups-and-cleanup/,tasks/taxonomy/,recipe-dredger/scheduling/,safety-policies/privacy-and-safety/, https://knownframe.com/privacy/cookdex/troubleshooting/The FAQ answers are on the docs pages they belong to, and the Documentation card covers the "Questions" entry point.
Kept as before: Report a problem (make, preview and download the diagnostics report) and Open a GitHub issue (
/issues/new).About page: a Documentation link at the top of Project Links. The server adds
links.docstoGET /about/meta, and both pages fall back to the same URL inconstants.js.Tools (the optional item): each job's sheet has a More about this job link to its section, such as
tasks/data-maintenance/#ingredient-parse. The Dredger links torecipe-dredger/.test_help_task_guide_ids_match_registrybecomestest_task_doc_links_match_registry, so every registered task still has to have a docs link, and a link to a removed task fails the test.Removed
GET /help/docs, along with_HELP_DOCSand_build_help_docs_payloadinrouters/meta.py. It readdocs/*.md, which.dockerignoreexcludes, so in the image it always returned an empty list. One of its files,PARSER_MIGRATION.md, didn't exist, and no page called the endpoint.Smoke test: the
/help/docscall is gone. The Help check used to open the FAQ and guide accordions; it now checks that each card's links point at knownframe.com, that the troubleshooting link is right, and that no long-form accordions are left. The About check also looks for the Documentation link. The markershelp:faq-openandhelp:task-guides-openare nowhelp:docs-linksandhelp:troubleshooting-link.CSS for the old guides (
.guide-*,.accordion-group-label) is removed, and a small.help-linksand.job-docs-linkare added.Kept in the app for offline and LAN-only installs
The default is an intro plus links. I kept only one thing that's useful without internet access:
Things I considered keeping and dropped:
settings_api.py).Overlap with #144
#144 merged while this was open. I merged
maininto this branch:docs/TASKS.md: tookmain's version, since the routes list moved out of it.docs/API.md: removed itsGET /help/docsline.AGENTS.md/CONTRIBUTING.md: Point user docs at knownframe.com #144 added the note that user docs live on knownframe.com. I added one sentence to each saying the in-app Help page and job sheets link there, so new help text goes on the site and not intoweb/src/constants.js. That covers the issue's last "Done when" item.Screenshots
These were taken from the running app with no Mealie connected, which is why the banner is showing. The images were added in a separate commit and removed in the next one, so they never reach the tree on
main.Verification
python -m pytest: all tests pass.ruff check src testsis clean.npm --prefix web test: 67/67 pass on Node 22.npm --prefix web run buildsucceeds.scripts/qa/run_local_webui_qa.py --iterations 1(the CI smoke test): passed with 16 checks.#fragmentexists as anidon its page. That's the 14 pages plus the 11 anchors used:where-things-are,sign-in-and-connect-mealie,clean-recipes,slug-repair,ingredient-parse,yield-normalize,reimport-recipes,health-check,tag-categorize,cleanup-duplicatesandmealie-backup.🤖 Generated with Claude Code