FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs(cli): document backend framework selection by AbhinRustagi · Pull Request #965 · thesysdev/openui · GitHub

docs(cli): document backend framework selection - #965

Merged
AbhinRustagi merged 2 commits into
mainfrom
be-framework-docs
Aug 25, 2026
Merged

docs(cli): document backend framework selection#965
AbhinRustagi merged 2 commits into
mainfrom
be-framework-docs

Conversation

AbhinRustagi commented Aug 13, 2026
edited
Loading

Copy link
Copy Markdown
Contributor

What

Documents --backend-framework across the CLI reference and the package and template READMEs.

Changes

  • Document the flag and its values, and that the framework prompt follows the template prompt — non-interactive runs default to default.
  • Add a matrix mapping each value to the route it produces for the Cloud and self-hosted templates.
  • Add a Conversation storage section: Cloud is the durable store for every Cloud variant, while self-hosted keeps messages in memory for the page session only.
  • Deployment guidance points at Vercel throughout.
  • Fix the Cloud template README, which told people to cp .env.example .env.local — the CLI writes .env, and no .env.example ships.

Docs only. Migrated from #785.

Test Plan

  • Verified locally

prettier --check clean, which is what docs CI gates on cli.mdx. Cross-checked every behavioural claim against the code in #964 — the default fallback, the prompt ordering, and the THESYS_API_KEY / OPENAI_API_KEY gate.

Checklist

  • I updated docs/README when needed
  • I considered backwards compatibility

vercel Bot commented Aug 13, 2026
edited
Loading

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
openui-docs Ready Preview Aug 25, 2026 3:25pm

AbhinRustagi marked this pull request as ready for review August 13, 2026 11:57
abhithesys previously approved these changes Aug 20, 2026
abhithesys previously approved these changes Aug 25, 2026
Keep the public description on backend frameworks; overlay stays an
internal implementation detail.
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants


Back | FazBrowse Home | New Git URL