Skip to content

docs(ui): user guide for flows, saved credentials, uploading a dataset and building a flow - #464

Merged
wmobley merged 1 commit into
developfrom
docs/user-guide-flows-uploads-credentials
Nov 20, 2026
Merged

wmobley merged 1 commit into
developfrom
docs/user-guide-flows-uploads-credentials

Conversation

@wmobley

@wmobley wmobley commented Nov 20, 2026

Copy link
Copy Markdown
Contributor

Brings the in-app User Guide (/docs/) up to date with this week's features. The guide had not changed since 2026-11-04. Docs only.

New pages

  • Run a flow (facilitator/run-a-flow.md):
    • finding a flow, and starting it from a thread with a collection input;
    • the "settings chosen by the flow's author" and "sends data outside DYNAMO" dialog;
    • following a run;
    • pausing for an edit, then resuming;
    • what a run records.
  • Saved credentials (saved-credentials.md):
    • add, replace and delete;
    • the model-server preset, with the base URL including /v1;
    • why a credential can't change during a run.
  • Upload a dataset (data-scientist/upload-a-dataset.md):
  • Build a flow and register a piece (data-scientist/build-a-flow.md):
    • registering an ETL piece from a GitHub commit: the main-branch rule, 30 requests an hour, 200 pieces per person;
    • approval;
    • the flow builder.

Updated pages: use-model.md, results.md, frame-question.md (sub-tasks under every task, and steps in the task tree), discovery.md, register-data.md, transformations.md, the two section index pages, troubleshooting.md (about 14 entries, using the exact messages from the code) and the glossary (flow, piece, collection, pause, credential). mkdocs.yml adds the new pages to the navigation.

How it was written: button labels, headings and messages were checked against ui-react/src. mkdocs build --strict passes.

Merge after #462, since the guide describes #462's upload page and task tree.

Screenshots: the places where one would help are marked with <!-- screenshot: --> comments, to be filled in from dev.

🤖 Generated with Claude Code

@vercel

vercel Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
monorepo Ready Ready Preview Nov 20, 2026 2:35pm UTC

@wmobley
wmobley merged commit 53e3a78 into develop Nov 20, 2026
40 checks passed

This branch was successfully deployed

1 active deployment
Preview — 24f0516d Deployed Nov 20, 2026 by vercel[bot]
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.

1 participant