Skip to content

docs: cover 5 shipped-but-undocumented features (#1013)#1364

Merged
chhoumann merged 2 commits into
masterfrom
chhoumann/1013-docs-coverage-audit
Jun 15, 2026
Merged

docs: cover 5 shipped-but-undocumented features (#1013)#1364
chhoumann merged 2 commits into
masterfrom
chhoumann/1013-docs-coverage-audit

Conversation

@chhoumann

@chhoumann chhoumann commented Jun 15, 2026

Copy link
Copy Markdown
Owner

What

Coverage follow-up to the #1013 docs UI-drift audit (PR #1329, merged). An ultracode 29-feature sweep cross-checked docs/docs against every recently shipped feature: 24/29 were already covered (FormatSyntax.md in particular is excellent), and an adversarial verify pass confirmed 5 real gaps. This PR fills them. Every gap shipped after the 2.13.1 release, so the edits are in docs/docs (Next) only — the frozen version-2.13.1 snapshot is correctly untouched.

Gaps closed

Feature PR Doc fix
Multiple template folder paths #1325 Settings.md: stale singular "Template Folder Path" → the "Template folder paths" list (add/remove, empty-list behaviour + its effect on the launcher)
Tab in multi-line prompt #764 FormatSyntax.md (#value-multiline) + QuickAddAPI.md (wideInputPrompt): Tab inserts/indents, Shift+Tab moves focus
Command icons #766/#1342 Settings.md new Command icons section: per-type defaults + the data.json icon override
Named suggester edge cases #148/#1336 FormatSyntax.md: name reuse is case-insensitive and first-write-wins
Note-picker recency ordering #745/#539/#1335 CaptureChoice.md: Quick-Switcher ordering, Excluded-files sink, "Create new note" row

Plus two opportunistic accuracy fixes while in the files:

  • Settings.md: documented the "Allow URI x-callback-url" toggle (a real AI & Online control the page was missing), with its off-by-default security rationale.
  • FormatSyntax.md: corrected a pre-existing {{GLOBAL_VAR}} note — the keyword is case-insensitive but the snippet name is case-sensitive (completeFormatter.ts does a plain object lookup).

Verification

  • Every claim was grounded in source and then checked by an adversarial verification workflow (accuracy-vs-source, completeness, style, links, version targeting). All findings from that pass are folded in — including dropping a wrong "same rule as {{GLOBAL_VAR}}" cross-reference and broadening the named-suggester conflict trigger.
  • cd docs && pnpm build succeeds with no broken-link errors.
  • Version targeting confirmed: all six feature commits post-date the 2.13.1 tag; no versioned_docs files touched.

Refs #1013. Does not close it on its own, but clears the audit's remaining "document new settings/options" tail.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated capture choice documentation with Quick Switcher-like ordering details and “create new note” row behavior.
    • Enhanced format syntax guide with multiline input keyboard behavior, case-insensitive named suggester matching, and global variable casing rules.
    • Added keyboard behavior notes for text input prompts.
    • Expanded settings documentation with support for multiple template folders, URI callback configuration guidance, and command icon customization (including override via data.json).

Coverage follow-up to the #1013 UI-drift audit (PR #1329). An ultracode
29-feature sweep found docs/docs covered 24/29 recent features; this fills
the 5 gaps (all shipped after the 2.13.1 snapshot, so docs/docs / Next only):

- Settings: replace the stale singular "Template Folder Path" with the
  "Template folder paths" list, incl. empty-list behaviour (#1325)
- FormatSyntax + QuickAddAPI: Tab inserts/indents in the multi-line and
  wideInputPrompt() prompts; Shift+Tab still moves focus (#764)
- Settings: per-type command icons + the data.json `icon` override (#1342)
- FormatSyntax: named-suggester reuse is case-insensitive and
  first-write-wins (#1336)
- CaptureChoice: note-picker Quick-Switcher ordering + the "Create new
  note" row (#1335)

Also adds the "Allow URI x-callback-url" toggle to the Settings page and
corrects a pre-existing GLOBAL_VAR case-sensitivity note. Docs build
verified locally (cd docs && pnpm build); CI path-ignores docs/**.
@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b0eb282c-57ff-4072-8ded-1ae450a3a114

📥 Commits

Reviewing files that changed from the base of the PR and between 012d26d and efeb6cf.

📒 Files selected for processing (1)
  • docs/docs/Settings.md
✅ Files skipped from review due to trivial changes (1)
  • docs/docs/Settings.md

📝 Walkthrough

Walkthrough

Documentation-only updates across four files: CaptureChoice.md gains capture destination ordering rules and conditional "Create new note" row behavior; FormatSyntax.md adds multiline Tab/Shift+Tab notes, clarifies named variable case-insensitivity and first-definition-wins, and refines GLOBAL_VAR casing rules; QuickAddAPI.md documents wideInputPrompt keyboard behavior; Settings.md pluralizes template folder paths, adds URI x-callback-url, and adds a Command icons subsection.

Changes

Documentation Updates

Layer / File(s) Summary
CaptureChoice destination ordering and create-note row
docs/docs/Choices/CaptureChoice.md
Adds ordering rules for the capture destination list (session/recent first, then alphabetical; excluded files sink but remain selectable) and documents the conditional "Create new note: <name>" row shown when "Create file if it doesn't exist" is enabled.
FormatSyntax: multiline keyboard, named variable reuse, GLOBAL_VAR casing
docs/docs/FormatSyntax.md
Documents Tab/Shift+Tab behavior in multiline prompts, replaces prior |name reuse notes with explicit case-insensitive matching and first-definition-wins semantics, and clarifies that GLOBAL_VAR keyword is case-insensitive while the snippet name is case-sensitive.
QuickAddAPI: wideInputPrompt keyboard behavior
docs/docs/QuickAddAPI.md
Adds a keyboard behavior note to wideInputPrompt describing Tab (inserts tab, indents selection) and Shift+Tab (moves focus) with a link to multi-line format syntax.
Settings: template folder paths, URI callbacks, command icons
docs/docs/Settings.md
Replaces single template folder path entry with multi-folder description, adds "Allow URI x-callback-url" setting under AI & Online, and extends Appearance with a "Command icons" subsection covering automatic glyphs and data.json override.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

  • chhoumann/quickadd#1265: The main PR's documentation updates to docs/FormatSyntax.md and the "Templates & Properties" template folder-path behavior overlap with the retrieved PR's TemplateChoice.md clarification that folder paths support QuickAdd format syntax.

Suggested labels

released

Poem

🐇 Hop, hop — the docs grow clear!
Tab indents, Shift+Tab steps away,
Folders stack, callbacks obey,
Icons glow on every choice's face.
A bunny dotted every "i" today! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: cover 5 shipped-but-undocumented features (#1013)' accurately and specifically describes the main change: documentation of five undocumented features across multiple docs files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chhoumann/1013-docs-coverage-audit

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 and usage tips.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 15, 2026

Copy link
Copy Markdown

Deploying quickadd with  Cloudflare Pages  Cloudflare Pages

Latest commit: efeb6cf
Status: ✅  Deploy successful!
Preview URL: https://e3153773.quickadd.pages.dev
Branch Preview URL: https://chhoumann-1013-docs-coverage.quickadd.pages.dev

View logs

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/docs/Settings.md`:
- Around line 49-52: The documentation section on automatic command icons
incorrectly identifies the icon type for Template choices. In the "Automatic
command icons" bullet point, update the icon reference from "document" to
"file-text" to accurately reflect which Lucide icon is actually assigned to
Template choices when they are converted to commands. The rest of the section
(the override mechanism via the icon field and the guidance about editing
data.json) is correct and requires no changes.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 382ba803-762c-4867-89c1-484b0f5a5401

📥 Commits

Reviewing files that changed from the base of the PR and between 9a30cf9 and 012d26d.

📒 Files selected for processing (4)
  • docs/docs/Choices/CaptureChoice.md
  • docs/docs/FormatSyntax.md
  • docs/docs/QuickAddAPI.md
  • docs/docs/Settings.md

Comment thread docs/docs/Settings.md
CodeRabbit: Template's icon is `file-text`, not "a document". List the
literal Lucide ids (file-text/pencil/terminal/folder) so the per-type
defaults match choiceUtils.ts and the override bullet's id framing.
@chhoumann chhoumann merged commit a36eb1a into master Jun 15, 2026
10 checks passed
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.

1 participant