docs: say what comes after a green test, for the layout that exists - #8
Merged
Conversation
The two feature READMEs stop at the test command, so the step after a green test is a guess: nothing says the feature reaches a real stack through `fun up --k8s`, that registration reads the same `handler.json` the test reads, or that an unregistered method's only symptom arrives later as `No service URL for ...`. Adds a Next section to both, and a page paragraph: a page is a lane rather than a UI framework, and a feature serving a site puts those methods in a second nested manifest (`handlers/pages/handler.json`, `"type": "node-page"`) that the platform builds as its own image — `route` and `accessChannels` being per method, as `features/checkout` shows across all three lanes. Docs only; placeholder tokens untouched.
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
Supersedes #7, which found a real gap — both feature READMEs stop at the test command, so the step after a green test is a guess — but wrote it against a layout this repository no longer has, and asserted two things about the page lane that are not true.
Why #7 cannot be merged as-is: it adds READMEs under
{typescript,python}/{job,sync,page}, six directories that #6 replaced with two surfaces (typescript/gql,typescript/sql) plushandler/{node-multi-method,python}. That is the merge conflict, and merging it would land six files no scaffold ever reads. Kind is a flag now, not a template — which both current READMEs already explain.The two claims worth catching before they became the documented design:
features/authandfeatures/sso… theirpages/is a Next.js app generated into the image at build time rather than committed." There is no Next.js anywhere:features/auth/pages/was deleted,features/sso/pages/holds nothing butnode_modules(leftover, worth removing there), and a page image is generated from a nested manifest of plain handlers. What docs: say what comes after the template is installed #7 read as "generated, not committed" is an empty directory.routeandaccessChannelssit at the top level while this feature has one method." They are per method by design and survive registration as such;features/checkoutis the reference across all three lanes from a single manifest:What this PR keeps from #7 is the part that checks out —
fun up --k8s,fun register --apply/--dry-run, and theNo service URL for "<task>"symptom of a method that never registered. One correction there too: registration failure is not merely unswallowed, itprocess.exit(1)s the bring-up (commands/up.ts), so the sentence says that instead of implying you might miss it.Added to
typescript/gql/README.mdandtypescript/sql/README.md: a Next section, and a page paragraph saying a page is a lane rather than a UI framework, and that a feature serving a site declares a second nested image:features/authis that reference — one page image, four landings. Docs only, placeholder tokens untouched,scripts/check-templates.mjsgreen.Link to Devin session: https://app.devin.ai/sessions/f3d7c42c8aea4065a2c2f8d780d6bdee
Requested by: @pyramation