docs, apps: add a reports guideline and shape the full apps to it - #6
Merged
Merged
Conversation
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.
An LLM writing an app from this repository had nothing telling it what a report should look like, and the seven full apps each printed a different shape. This adds the guideline and makes the apps its reference implementations.
docs/06-reports.mdis the guideline. A report is the app's stdout up to 1 MiB, Markdown by convention, and it reads on a phone, as raw text and rendered. Title in Title Case, the finding straight under it, then Evidence, Method, Limitations and Sources. No app name, version or grant list, since the Ark reports those beside the report. Pick a voice and keep it; the examples are toys and read that way, with the serious register on record for heavier apps. Genomics vocabulary, never clinic vocabulary. Genotypes printed exactly as the file holds them. Plain Markdown only, with no images, HTML, footnotes, encoded content, dates or run ids.AGENTS.mdrestates it in imperative form beside the build, run and check commands, for agents working in a checkout.v1/genome/referenceand readbuild, so positions carry the assembly rather than an assumed label. The two narrow fixture roots gainreference/buildso those apps still run there.01-app-model.mdpoint at the new page.The
referencegrant puts the stored reference genome on the approval screen of a one-variant app, and needs the reference slot filled on the Ark. The guideline says so, and the demos take that trade.