Skip to content

docs: describe the current no-save flow in README and AGENTS.md - #17

Merged
nnkogift merged 2 commits into
nnkogift/nnk-187-bump-form-utils-to-alpha-14from
nnkogift/nnk-185-update-readme-agentsmd-and-the-linear-project-description-to
Oct 26, 2026
Merged

nnkogift merged 2 commits into
nnkogift/nnk-187-bump-form-utils-to-alpha-14from
nnkogift/nnk-185-update-readme-agentsmd-and-the-linear-project-description-to

Conversation

@nnkogift

Copy link
Copy Markdown
Owner

Stack (app repo): 2 of 3. Base: #15 (form-utils alpha.14 bump). Next: NNK-198 docs-impact process.

Closes NNK-185. AGENTS.md and the README still said form values are posted to the tracker resource on save. Since ed8e985 the only write call is the importMode=VALIDATE dry run, so anyone writing docs from them would document the wrong behaviour.

  • AGENTS.md: the Forms section now describes the real flow: Validate form, Verify with server (dry run), the read-only server effects summary from Preview server effects / Preview on-complete effects, and the completion pass. Payload builders in utils/trackerPayloads.ts are used only for the dry run. Also brought up to date against the source: hooks and devtools export lists (including EFFECT_LEGEND, PROVENANCE_TAGS), enrollment wording, showHiddenFields / hidden-field placeholders, the About page and the program list help-links footer, and what CI actually runs.
  • README: replaces the App Platform boilerplate with what the app is, who it's for, the "nothing is saved" fact, supported DHIS2 versions, links to the docs site (https://prp-docs.nnkogift.dev), App Hub (coming soon) and dhis2-form-utils, and short dev commands. The screenshot is a TODO until the docs screenshot pipeline (NNK-190) produces it.
  • No changeset (docs only).

Checks: pnpm lint, pnpm typecheck, pnpm test (39 suites, 197 tests) pass.

Docs impact: none, this is the source the docs are written from.


Generated by Claude Code

@coderabbitai

coderabbitai Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 227169f6-eb9c-4f33-ba16-74361d20e457

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@nnkogift
nnkogift merged commit 0a1bfe3 into nnkogift/nnk-187-bump-form-utils-to-alpha-14 Oct 26, 2026
1 check passed

Copy link
Copy Markdown
Owner Author

These changes reached alpha through #19. This PR was merged into its stacked base branch, not alpha.


Generated by Claude Code

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.

2 participants