Record CLI-Reference overlay findings (B-0016) + open next prerelease cycle#125
Conversation
…ctor issue #124 Ran a throwaway extractor + coverage diff (experiments/cliref-*.ts, local-only) against ros-help.db @ v0.11.1 to answer B-0016's blocking questions with data: - Join key is NOT 1:1 — the manual leaks internal module segments into heading paths (caps-man/acl/access-list -> real /caps-man/access-list); needs normalization + stored raw-vs-resolved path pair. - Hardened regex suffices (no MDX parser); three edge cases documented. - Payoff: 3,852 read-only args with no /console/inspect equivalent, 120 command menus genuinely absent, 541 hardware-gated settable args. B-0016 updated with findings, strawman cliref_* schema, and new open questions 7-10; questions 2 and 4 marked answered. Scoped agent-ready ETL issue cut as #124; BACKLOG index updated. project-words.txt gains the module-name aliases and code identifiers. package.json bumped to 0.11.2-alpha.0 to open the next prerelease cycle (release likely holds at 0.11.1). experiments/ stays local (gitignored) — to be ported into src/ by #124. Refs #33, #124, #25 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughRefreshes the B-0016 CLI-reference overlay briefing with extraction findings, schema direction, and remaining questions. Also updates the package prerelease version, ignores experimental outputs, and expands the spelling dictionary. ChangesCLI-reference overlay design
Repository metadata and vocabulary
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related issues
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Pull request overview
Records the 2026-07-20 CLI-Reference overlay extraction experiment outcomes in the B-0016 briefing, updates the project backlog pointers to the newly cut scoped ETL issue (#124), and opens the next prerelease cycle by bumping the package version.
Changes:
- Expanded
B-0016with experiment findings (corpus shape, parsing edge cases, join-key aliasing) and updated its revisit metadata/related issues. - Updated
BACKLOG.mdB-0016 index row to reflect the experiment outcome and link to #124. - Bumped
package.jsonto0.11.2-alpha.0, added spelling dictionary entries, and addedexperiments/artifact ignores.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
briefings/B-0016-cli-reference-overlay-design.md |
Adds experiment findings + updates briefing metadata and next-steps pointers to #124. |
BACKLOG.md |
Updates the B-0016 row to reflect the experiment and link to the new scoped extractor issue. |
package.json |
Version bump to open the next prerelease cycle (0.11.2-alpha.0). |
project-words.txt |
Adds new domain terms discovered/used by the briefing and planned extractor work. |
.gitignore |
Ignores generated CLI-Reference experiment DB/output artifacts. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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 `@briefings/B-0016-cli-reference-overlay-design.md`:
- Around line 236-237: Update the unresolved-status statement in the briefing to
remove the completed issue `#124` cut as a prerequisite, while retaining only the
remaining extractor completion/validation and Question 3 answer gates.
- Around line 150-159: Add explicit raw_path and resolved_path fields to
cliref_nodes in the schema definition, replacing the single path-only
representation while preserving the node identity and alias join contract. Apply
the same update to the corresponding schema/table definition at the other
referenced occurrence.
- Around line 183-187: Update question 1 in the design document to evaluate only
the three standalone cliref_* tables selected by the findings and current
direction. Remove the obsolete columns-on-schema_nodes alternative and preserve
only unresolved tradeoffs within the three-table design, including its
versioned/version-less separation and join/query implications.
In `@project-words.txt`:
- Around line 58-63: Restore the lexical ordering of project-words.txt by moving
chancfg before centrs, while keeping the surrounding dictionary entries and
spelling unchanged.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: a124c395-27f6-480e-a579-f06327fa5f58
📒 Files selected for processing (5)
.gitignoreBACKLOG.mdbriefings/B-0016-cli-reference-overlay-design.mdpackage.jsonproject-words.txt
📜 Review details
⏰ Context from checks skipped due to timeout. (3)
- GitHub Check: copilot-pull-request-reviewer
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: Analyze (javascript-typescript)
🧰 Additional context used
📓 Path-based instructions (5)
*
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Keep this Copilot instructions file short; put substantive rules in narrow instruction files under
.github/instructions/*.instructions.md.
Files:
package.jsonBACKLOG.mdproject-words.txt
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.md: Keep each project documentation file limited to its canonical role; prefer the documented canonical home instead of creating a new top-level Markdown file.
Do not duplicate content from this routing index; move operational detail, schema blocks, or long rule lists to their canonical documentation or instruction files.
Apply the repository's Markdown linting and fenced-code conventions, while excluding LLM instruction files where the repository explicitly requires that exclusion.
Files:
BACKLOG.mdbriefings/B-0016-cli-reference-overlay-design.md
BACKLOG.md
📄 CodeRabbit inference engine (CLAUDE.md)
Put loose, unshaped thoughts in the
BACKLOG.mdInbox and items waiting on a named external event inBACKLOG.mdTriggers.
Files:
BACKLOG.md
**/*.{ts,tsx,md}
📄 CodeRabbit inference engine (AGENTS.md)
Keep the attribution boundary visible when community RouterOS skills surface, because they are supplemental rather than official MikroTik documentation.
Files:
BACKLOG.mdbriefings/B-0016-cli-reference-overlay-design.md
briefings/B-*.md
📄 CodeRabbit inference engine (CLAUDE.md)
Store grounded research and decision support in
briefings/B-*.md.
Files:
briefings/B-0016-cli-reference-overlay-design.md
🪛 LanguageTool
briefings/B-0016-cli-reference-overlay-design.md
[grammar] ~219-~219: Ensure spelling is correct
Context: ...ata on existing records. Relevant to restraml too (OpenAPI response schemas). 9. **Do...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (5)
briefings/B-0016-cli-reference-overlay-design.md (1)
8-11: LGTM!Also applies to: 60-149, 160-177, 178-182, 188-229, 239-243
BACKLOG.md (1)
85-85: LGTM!.gitignore (1)
48-51: LGTM!package.json (1)
3-3: LGTM!project-words.txt (1)
85-85: LGTM!Also applies to: 105-108, 170-171, 264-264, 323-328, 342-344, 361-361, 415-415, 433-433
…1 decided - Both strawman schema blocks now show path_raw + path_resolved (matching #124 acceptance criteria) instead of a single path column. - Question 1 (table shape) marked decided: three standalone cliref_* tables, columns-on-schema_nodes alternative recorded as rejected. - "Current lean" no longer gates on cutting #124 (already done); gate is now extractor-landed + Q3 answered. CodeRabbit's project-words.txt sort finding dismissed: the word section is correctly sorted (centrs < chancfg < changefreq) in both C and locale collation. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Docs/backlog only — no
src/code, no DB rebuild. Records the outcome of the 2026-07-20 CLI-Reference extraction experiment and cuts the scoped ETL issue it enabled.What's here
briefings/B-0016-...md— findings from a throwaway extractor + coverage diff (experiments/cliref-*.ts, local-only, gitignored, to be ported by CLI-Reference DB overlay: lossless ETL, inspect crosswalks, and export #124). Answers the two questions that were blocking a scoped ETL issue:caps-man/acl/access-list→ real/caps-man/access-list); 24/144 unmatched nodes, 19 spurious segments. Needs normalization + a stored raw-vs-resolved path pair./console/inspect: 3,852 read-only args with no inspect equivalent, 120 command menus genuinely absent, 541 hardware-gated settable args. Corpus: 228 pages → 1,051 nodes → 11,066 args @v0.11.1.cliref_*three-table schema; new open questions 7–10; provenance format (Q3) left open.BACKLOG.md— B-0016 row updated with the CLI-Reference DB overlay: lossless ETL, inspect crosswalks, and export #124 pointer.project-words.txt— module-name aliases + code identifiers (cliref,unsettable,dpathcfg,remoteap, …).package.json—0.11.1→0.11.2-alpha.0to open the next prerelease cycle (release likely holds at 0.11.1; alpha/beta resume for DB-first CLI/exportwork, incl. the CLI-Reference data centrs needs per explain phase 0: canonicalization grounding lab (ratification gate for #90) centrs#185)..gitignore— ignore the regenerableexperiments/artifacts.No CHANGELOG entry: the alpha bump has no external effect until something ships, and there's no behavior change here.
Refs #33 (precursor design pass, commented), #124 (scoped extractor, cut), #25 (query-behavior half, stays separate).
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Chores
0.11.2-alpha.0.