Update the live-demo sections of the field FAQ - #35
Merged
Merged
Conversation
The live-demo sections of docs/FAQ.md did not agree with the UI and the pipeline. The stage list was not the list that public/app.js shows. The text promised an API and Postgres, but a website prompt gives only a static site. There was no step to rehearse or to keep a fallback app. Now the FAQ: - Lists the ten stages that the UI shows. - Tells which prompt gives a static site, and which gives an API and a database. It also tells presenters to use a kind of business, not the name of a real company. - Adds a rehearsal, a fallback app, and the checks to do before a presenter goes on stage. - Replaces the talking points with one line for each stage, and names the worker of each stage: an agent, workflow code, or Render. - Says where the agents use the Render MCP server: the architect reads the workspace, and the deploy manager reads a failed deploy. Workflow code reads Render over the REST API. - Tells where the photographs come from, adds app/images.ts to the key files, and adds a troubleshooting row for missing photographs. - Corrects the cost levers, the cost warning, the answers about what the factory builds and about the free tier, and the answer about a stuck run, which changed in PR #27. It also corrects five links. Three links in docs/FAQ.md had paths from the root of the repository. Two links in docs/README.md pointed to ../FAQ.md. The lines that tell what the deploy manager reads do not change. PR #34 changes them, and this change merges with it without a conflict. Co-Authored-By: Claude Opus 5.5 <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
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
After PRs #27 to #32, the live-demo sections of
docs/FAQ.mddid not agree with the UI and the pipeline. This change makes them agree, and corrects five links.Changes
docs/FAQ.md:public/app.js.app/images.tsto the key files, and adds a troubleshooting row for missing photographs.docs/README.md: corrects two links that pointed to../FAQ.md.Relation to #34
#34 changes the lines that tell what the deploy manager reads, in
README.md,docs/README.md, anddocs/FAQ.md. This change does not touch those lines. A trial merge of the two branches has no conflict.Test plan
README.md#architecture-at-a-glance,docs/README.md#when-to-use-this-reference,docs/README.md#current-limitations, anddocs/FAQ.md.npm run checkdoes not read Markdown.🤖 Generated with Claude Code