Skip to content

Update the live-demo sections of the field FAQ - #35

Merged
anurag merged 1 commit into
mainfrom
ag/demo-docs
Sep 24, 2026
Merged

anurag merged 1 commit into
mainfrom
ag/demo-docs

Conversation

@anurag

@anurag anurag commented Sep 24, 2026

Copy link
Copy Markdown
Contributor

Summary

After PRs #27 to #32, the live-demo sections of docs/FAQ.md did not agree with the UI and the pipeline. This change makes them agree, and corrects five links.

Changes

docs/FAQ.md:

  • Lists the ten stages that the UI shows, from public/app.js.
  • Tells which prompt gives a static site, and which gives an API and a database. 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 Use Hono middleware in the gateway, and reconcile only failed tasks #27.
  • Corrects three links that had paths from the root of the repository.

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, and docs/FAQ.md. This change does not touch those lines. A trial merge of the two branches has no conflict.

Test plan

  • Each link target exists: README.md#architecture-at-a-glance, docs/README.md#when-to-use-this-reference, docs/README.md#current-limitations, and docs/FAQ.md.
  • A trial merge with Give the deploy manager the logs of each failed deploy #34 has no conflict.
  • CI. The change is Markdown only, and npm run check does not read Markdown.

🤖 Generated with Claude Code

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>
@anurag
anurag merged commit 7721136 into main Sep 24, 2026
3 checks passed
@anurag
anurag deleted the ag/demo-docs branch September 24, 2026 05:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant