feat: Help app for authoring in-app help #1

2026-10-14T02:41:11Z

KofTwentyTwo commented

2026-10-14 02:41:11 +00:00

(Migrated from github.com)

Summary

This is the authoring experience for QQQ in-app help. Core keeps storage, targeting, search and coverage (QRun-IO/qqq#1177); this qbit adds no tables and authors core's helpContent, a documented pre-standard naming exception.

Help app home:
- coverage totals per kind;
- a full-width list of objects missing help, each with an "Add help" link that prefills the key;
- recent changes.
All three are typed widgets (no HTML).
Actions on helpContent, run as standard streamed ETL with Review/Result lines:
- "Preview help" renders the record's help through the standard step help renderer, using a runtime frontend-step adjustment.
- "Apply help changes now" runs the core reload.
- "Check help keys" validates keys against core's target catalog.
Bulk edit, import and export use QQQ's standard table features.
Permissions:
- viewers get help.read and help.hasAccess;
- authors also get help.insert, help.edit, help.delete and help.author.hasAccess.

Pinned to QQQ 4.1.0-RC.7, which carries qqq#1177 and #1198. The review surface (upstream-changed, retired and stale keys, per-bundle coverage) uses core's Sync, Accept upstream and Keep mine actions.

Test plan

mvnw -o verify passes locally: 19 tests, checkstyle clean, coverage 98.5% instructions and 100% classes.
CI once pinned to the RC.

🤖 Generated with Claude Code

## Summary This is the authoring experience for QQQ in-app help. Core keeps storage, targeting, search and coverage (QRun-IO/qqq#1177); this qbit adds no tables and authors core's `helpContent`, a documented pre-standard naming exception. - **Help app home**: - coverage totals per kind; - a full-width list of objects missing help, each with an "Add help" link that prefills the key; - recent changes. All three are typed widgets (no HTML). - **Actions on `helpContent`**, run as standard streamed ETL with Review/Result lines: - "Preview help" renders the record's help through the standard step help renderer, using a runtime frontend-step adjustment. - "Apply help changes now" runs the core reload. - "Check help keys" validates keys against core's target catalog. - Bulk edit, import and export use QQQ's standard table features. - **Permissions:** - viewers get `help.read` and `help.hasAccess`; - authors also get `help.insert`, `help.edit`, `help.delete` and `help.author.hasAccess`. **Pinned** to QQQ 4.1.0-RC.7, which carries qqq#1177 and #1198. The review surface (upstream-changed, retired and stale keys, per-bundle coverage) uses core's Sync, Accept upstream and Keep mine actions. ## Test plan - [x] `mvnw -o verify` passes locally: 19 tests, checkstyle clean, coverage 98.5% instructions and 100% classes. - [ ] CI once pinned to the RC. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: QRun-IO/qbit-help#1