Repository navigation
feat: a completed app includes a user manual that stays current with the app - #102
Merged
Merged
Conversation
…current The manual was written only when the person asked for one after the build, so an app counted as done without it and nothing checked a manual against the app once written. The coder's instructions now put docs/USER-MANUAL.md beside README.md in what the app ships and in what done means, written for the people who use the app in plain, non-technical standard American English. check-app reports a missing manual as a docs problem and goes on, so the rest of the check still runs and every page's picture is saved under docs/manual/ for the manual to show. Once a manual exists it is held to the app: a picture of a page that no longer opens, and an area of the app opened that the manual never shows, both fail the check, which is what sends the coder back to the manual after a change. Refs #95
The manual lived only in the coder's workspace and the downloaded zip. The hub now serves it: docs/USER-MANUAL.md as the live coder keeps it, with the pictures it shows carried as data URLs, else the one filed with the latest app, whose pictures the bundle holds as binaries. The workspace pane gains a User Manual tab beside the live preview once the build has a manual, rendered with its pictures in place, and read again every minute while the coder works, since the manual follows the app. Closes #95
|
Triage: Pass No changes needed from you. A maintainer will review this pull request. Triage will approve, request review. |
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.
Closes #95
Stacked on #101, which it shares the document pane's tab selection with; its base should move to
mainonce #101 merges.Items 1, 2, 4 and 5 of the issue; item 3 (mockup pictures for screens the check cannot reach) is left for a follow-up.
What changed
Coder side (
workflows/coder/starter/AGENTS.md,workflows/coder/check/check-app.ts)README.mdanddocs/USER-MANUAL.md, written once the features work and before the app is filed, and the done sentence names both. The manual is for the people who use the app, in plain, non-technical standard American English, never a developer's view of the code.docs/manual/whether or not the manual shows it yet. A manual with no picture is reported the same way instead of stopping the run.Hub and UI
packages/schemas/src/artifact.ts:UserManual, the markdown with its pictures keyed as the markdown names them, as data URLs.apps/hub/src/artifacts/design-draft.ts:readUserManualreadsdocs/USER-MANUAL.mdand the pictures it shows from the coder's workspace with the same symlink-safe reads the draft uses;manualPictureRefsandmanualPicturesare shared with the filed-app path. Sizes are bounded.apps/hub/src/artifacts/service.tsandroutes.ts:GET /api/tenants/:t/projects/:p/manualserves the live coder's manual, else the one filed with the latest app from the bundle's binaries.packages/client:manual(tenantId, projectId).apps/web: a User Manual tab in the document pane beside the live preview once a manual exists, rendered with its pictures in place, read again every minute while the coder works. The pane's tab selection moved into aselectTabhelper to make room without crossing the complexity limit.How it was verified
tsc --noEmitpasses for the hub, the web app and the client;oxlint --deny-warningsand Prettier pass on every changed file.bun --conditions=intx-src testpasses forapps/web/src/pages/workspace,apps/hub/src/artifacts(two new tests for the picture reader) andapps/hub/src/builds: 97 tests.docs/manual/home.png. With a manual naming a picture of a page that does not exist, it reported that picture as of a page that may have moved or gone and the home page as not shown.Replaces #96.