Skip to content

Say how to run the journey, where to get the image, and what nothing sweeps - #493

Merged
davidmckayv merged 1 commit into
mainfrom
docs/match-reality
Sep 11, 2026
Merged

Say how to run the journey, where to get the image, and what nothing sweeps#493
davidmckayv merged 1 commit into
mainfrom
docs/match-reality

Conversation

@davidmckayv

Copy link
Copy Markdown
Contributor

Documentation only. Three things it asked for that could not be done from what it said.

The smoke journey needs a session. Every route it proves is behind requireUser, and the
file sent no credentials, so three of its five tests answered 401 on any deployment with an
identity provider, which is every deployment this repository will start. development.md and
releasing.md now say so, and say where the cookie comes from; the generated release PR
checklist asks for the journey with OPENBOT_SMOKE_COOKIE set, rather than asking for a result
nobody could produce.

Deploying said to build the image. A release has published one since v0.0.8, so the first
command is now docker run ghcr.io/copilotkit/openbot:latest in both README.md and
deployment.md, with the build kept for anybody deploying a tree of their own, and the
digest-pinning advice pointed at.

Nothing outside Kubernetes sweeps staged attachments. The chart runs it hourly;
docker-compose.yml and scripts/start.sh do not run it at all. On a laptop that is nothing
until the thirty-second unsent file, where the refusal a person sees promises a clearing that
nothing performs. development.md says it beside the ports, where somebody running the stack
will meet it.

Checked against the tree rather than against the older documentation:

  • the app is served by the API on the same origin inside the image (APP_DIST_DIR, PORT=3001
    in the Dockerfile), so the image really is one port and the app is not on 3010 there
  • the sweep defaults to 24 hours and takes fractional hours as its one positional argument
  • the per-person ceiling on unsent files is four messages' worth, and removing a file in the
    composer deletes the row, so it takes abandoned drafts to reach
  • every variable these documents name exists in the code, and every key .env.example ships is
    documented somewhere

…sweeps

Three things the documentation asked somebody to do that they could not do from what it
told them.

The smoke journey needs a session. Every route it proves is behind requireUser, so a run
without one answers 401 three times and reads as a broken deployment. development.md and
releasing.md now say so and where the cookie comes from, and the release PR template asks
for the journey with the variable set rather than asking for a result nobody can produce.

Deploying said to build the image. Every release has published one since v0.0.8, so the
first command anybody runs no longer needs a clone and a toolchain. The build stays, for
somebody deploying a tree of their own, and the digest-pinning advice is pointed at.

And nothing outside Kubernetes reclaims a staged attachment. The chart runs the sweep
hourly; docker-compose.yml and start.sh do not run it at all, which is fine on a laptop
until the thirty-second unsent file, where the refusal a person is shown promises a clearing
that nothing performs. development.md says it, beside the ports, where somebody running the
stack will meet it.

Checked against the tree rather than against the older documentation: the app is served by
the API on the same origin in the image (APP_DIST_DIR, PORT=3001 in the Dockerfile), the
sweep's window defaults to 24 hours and takes fractional hours, the per-person ceiling is
four messages' worth, and removing a file in the composer deletes the row. Every variable
these documents name exists in the code, and every key .env.example ships is documented.
@davidmckayv
davidmckayv merged commit c3c43bd into main Sep 11, 2026
16 checks passed
@davidmckayv
davidmckayv deleted the docs/match-reality branch September 11, 2026 22:12
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