Skip to content

Point the in-app Help page at the CookDex docs site - #145

Merged
thekannen merged 5 commits into
betafrom
claude/vigilant-jepsen-90b46a
Oct 20, 2026
Merged

thekannen merged 5 commits into
betafrom
claude/vigilant-jepsen-90b46a

Conversation

@thekannen

@thekannen thekannen commented Oct 19, 2026 •

Copy link
Copy Markdown
Owner

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_FAQ and HELP_TROUBLESHOOTING are 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:

      Card Links to
      The places in CookDex getting-started/#where-things-are
      Connecting things install/, getting-started/#sign-in-and-connect-mealie, database-connection/
      Jobs in Tools tasks/, tasks/data-maintenance/, tasks/backups-and-cleanup/, tasks/taxonomy/, recipe-dredger/
      Scheduling and safety scheduling/, safety-policies/
      Privacy privacy-and-safety/, https://knownframe.com/privacy/cookdex/
      When something's wrong 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.docs to GET /about/meta, and both pages fall back to the same URL in constants.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 to recipe-dredger/. test_help_task_guide_ids_match_registry becomes test_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_DOCS and _build_help_docs_payload in routers/meta.py. It read docs/*.md, which .dockerignore excludes, 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/docs call 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 markers help:faq-open and help:task-guides-open are now help:docs-links and help:troubleshooting-link.

  • CSS for the old guides (.guide-*, .accordion-group-label) is removed, and a small .help-links and .job-docs-link are 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:

  • First steps (4 lines: connect Mealie, scan, review the findings, turn on an automation). It's what someone needs on a first run, before they know whether the docs site is reachable. Each line points at an in-app page, not at docs content, and the card links to Getting started for the full text.

Things I considered keeping and dropped:

  • "Can't reach Mealie" tips, such as localhost inside Docker. Test Mealie in Settings already returns that hint when the address is localhost inside a container (settings_api.py).
  • What preview means. The job sheet and the Tools header already say a preview changes nothing.
  • Reading a failed run. The troubleshooting card's one-line intro says each run's details and Technical details are in Recent activity.

Overlap with #144

#144 merged while this was open. I merged main into this branch:

  • docs/TASKS.md: took main's version, since the routes list moved out of it.
  • docs/API.md: removed its GET /help/docs line.
  • 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 into web/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.

Help, light Help, dark
Help light Help dark
About Job sheet in Tools
About Job sheet

Verification

  • python -m pytest: all tests pass. ruff check src tests is clean.
  • npm --prefix web test: 67/67 pass on Node 22. npm --prefix web run build succeeds.
  • scripts/qa/run_local_webui_qa.py --iterations 1 (the CI smoke test): passed with 16 checks.
  • I curled every knownframe.com URL the app now links to: each returns 200, and each #fragment exists as an id on 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-duplicates and mealie-backup.

🤖 Generated with Claude Code

thekannen and others added 3 commits October 19, 2026 15:12
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>
@thekannen thekannen added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 19, 2026
@thekannen
thekannen changed the base branch from main to beta October 19, 2026 20:32
…cs site

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@thekannen
thekannen merged commit df87d10 into beta Oct 20, 2026
9 checks passed
@thekannen
thekannen deleted the claude/vigilant-jepsen-90b46a branch October 20, 2026 14:45
@thekannen thekannen mentioned this pull request Oct 20, 2026
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Point the in-app Help page at the knownframe.com docs instead of bundling its own copy

1 participant