docs: update uf init docs to reflect --no-embeddings default - #232
Conversation
jflowers
left a comment
There was a problem hiding this comment.
PR Review: #232 — docs: update uf init docs to reflect --no-embeddings default
Local Tool Results
| Tool | Command | Status |
|---|---|---|
| Hugo build | npm run build |
PASS (140 pages) |
Walkthrough
| File | Change | Focus |
|---|---|---|
content/docs/getting-started/knowledge.md |
Step 3 updated to dewey index --no-embeddings; cross-reference to Global CLI Flags |
documentation |
content/docs/getting-started/developer.md |
--force flag table + Sub-Tool Init section note --no-embeddings deferral |
documentation |
content/docs/reference/cli.md |
--force flag description updated for --no-embeddings |
documentation |
content/docs/getting-started/common-workflows.md |
Setup workflow description updated to dewey index --no-embeddings |
documentation |
Linked Issues
| Issue | Title | Criteria |
|---|---|---|
| #211 | docs: uf init --force no longer hangs on Dewey reindexing | 2/3 COVERED |
✓ Update uf init reference to note --no-embeddings default |
||
| ✓ Document how to trigger embedding generation separately | ||
| ⏸ Note in release notes (deferred — design decision D3, no changelog infrastructure) |
Summary
Clean, tightly scoped documentation-only PR that accurately updates 4 content pages to reflect the upstream --no-embeddings behavioral change in uf init --force. Spec artifacts are thorough, build passes, and changes are internally consistent.
Alignment
No issues found. All 4 target pages updated per spec. Blog post reviewed and left unchanged with documented rationale.
Security
No issues found.
Constitution Compliance
Content Accuracy (I), Minimal Footprint (II), Visitor Clarity (III) — all PASS.
Verdict
APPROVE — Well-executed documentation sync with complete requirement coverage, passing build, and full constitution alignment.
This review was generated by /uf.review-pr (AI-assisted).
Upstream Implementation VerificationUpstream PR: unbound-force/unbound-force#321 (merged 2026-07-01) Claim-by-Claim Verification
All 4 content file changes and the blog-post-skip decision are accurate against the implementation at HEAD. Tests in Command NamingNo slash commands are referenced in this PR. The Adjacent Open Issues
SummaryAll claims in this PR are verified accurate against the upstream implementation at HEAD. No naming discrepancies, no contradictions with adjacent open issues. The OpenSpec artifacts (proposal, specs, design, tasks) are well-structured and the design decisions (in-place edits, DRY cross-refs, skip release notes, minimal blog update) are sound and correctly applied. |
jflowers
left a comment
There was a problem hiding this comment.
PR Review: #232 — docs: update uf init docs to reflect --no-embeddings default
Summary
Tight, documentation-only PR that correctly updates four content pages to reflect the upstream --no-embeddings behavioral change in uf init --force. Spec artifacts are complete, build passes (140 pages), and all content changes are internally consistent.
Local Tool Results
| Tool | Status |
|---|---|
npm run build |
PASS |
Findings
[MEDIUM] Stray runtime artifact committed — .uf/replicator/replicator.log is a new empty file with no relationship to the documentation change. The .gitignore covers .uf/replicator/*.db patterns but omits *.log, which allowed this to slip through. Violates Zero-Waste Mandate (AGENTS.md Behavioral Constraint #1).
Fix: Remove from tracking (git rm --cached .uf/replicator/replicator.log) and add .uf/replicator/*.log to .gitignore.
[LOW] Issue #211 release-notes criterion deferred — Design decision D3 explicitly documents this deferral (no changelog infrastructure). Acknowledged, not silently dropped. No action required.
Passing Checks
- All four target pages updated per spec ✓
- Blog post reviewed and correctly left unchanged ✓
- Cross-reference anchor
#global-cli-flagsverified ✓ - Security: no concerns (docs-only) ✓
- Constitution alignment: Content Accuracy, Neighborhood Rule, Security by Default all PASS ✓
Verdict
REQUEST CHANGES — Remove .uf/replicator/replicator.log from tracking and add the pattern to .gitignore. No changes to documentation content are required. Once the stray file is addressed, this is ready to approve.
This review was generated by /uf.review-pr (AI-assisted).
…ings Incorporates content from PRs #232 and #244: - Structured PR descriptions, PR template detection, AI attribution sections added to common-workflows.md /finale documentation - --no-embeddings flag documented in uf init Dewey initialization across common-workflows.md, developer.md, and cli.md - Additional guardrails (PR approval, --body-file) added to /finale - Session lifecycle table updated to mention structured description
Documents that uf init runs dewey index --no-embeddings for faster initialization, deferring embedding generation. References the existing --no-embeddings flag in the CLI flags table. Content sourced from PR #232 (uf-init-no-embeddings-docs).
… artifacts Addresses PR unbound-force#232 review feedback from @jflowers. Removes the accidentally-tracked empty .uf/replicator/replicator.log and adds .uf/replicator/*.log and .uf/feedback/ to .gitignore so runtime logs and the feedback cache are never committed. Resolves the Zero-Waste Mandate violation flagged in review. Signed-off-by: Yvonne Devlin <ydevlin@redhat.com> Assisted-by: claude-opus
uf init --force now passes --no-embeddings to dewey index, deferring embedding generation for faster initialization. Updated 4 pages to reflect the behavioral change: - knowledge.md: step 3 of uf init sequence - developer.md: --force flag table and Sub-Tool Init section - cli.md: --force flag description - common-workflows.md: setup workflow description Each page notes that embedding generation is deferred and guides users to run dewey index separately for semantic search. Closes unbound-force#211
… artifacts Addresses PR unbound-force#232 review feedback from @jflowers. Removes the accidentally-tracked empty .uf/replicator/replicator.log and adds .uf/replicator/*.log and .uf/feedback/ to .gitignore so runtime logs and the feedback cache are never committed. Resolves the Zero-Waste Mandate violation flagged in review. Signed-off-by: Yvonne Devlin <ydevlin@redhat.com> Assisted-by: claude-opus
8020525 to
724ac0f
Compare
|
Thanks for the review! Addressed below. [MEDIUM] Stray [LOW] Issue #211 release-notes criterion — Agreed, no action needed. Design decision D3 documents this deferral (no changelog infrastructure yet); it's an explicit acknowledgment, not a silent drop. |
Summary
Updates documentation across 4 content pages to reflect the upstream
behavioral change from unbound-force/unbound-force#321:
uf init --forcenow passes
--no-embeddingstodewey index, deferring embeddinggeneration for faster initialization.
Closes #211
Changes
content/docs/getting-started/knowledge.mduf initCreates" now showsdewey index --no-embeddingswith cross-reference to Global CLI Flags tablecontent/docs/getting-started/developer.md--forceflag table row and Sub-Tool Initialization section both note--no-embeddingsdeferralcontent/docs/reference/cli.md--forceflag description updated to mention--no-embeddingscontent/docs/getting-started/common-workflows.mddewey index --no-embeddingsAll pages include guidance to run
dewey indexseparately to generateembeddings for semantic search.
The blog post (
dewey-knowledge-retrieval.md) was reviewed and leftunchanged — its mention of
uf initis general enough to remain accurate.Spec artifacts
OpenSpec change:
openspec/changes/uf-init-no-embeddings-docs/proposal.md— motivation, affected pages, constitution alignmentspecs/content-accuracy.md— delta requirements with Given/When/Then scenariosdesign.md— 4 decisions (in-place edits, DRY cross-refs, skip release notes, minimal blog update)tasks.md— 5 content tasks + 3 verification tasks, all completeReview council
6/6 APPROVE (adversary, architect, guard, testing, sre, curator). No
REQUEST CHANGES findings.
Verification
npm run buildpasses (140 pages)uf init+dewey indexreferences checked, no stale content