docs: update uf init docs to reflect --no-embeddings default - #232
Open
yvonnedevlinrh wants to merge 1 commit into
Open
docs: update uf init docs to reflect --no-embeddings default#232yvonnedevlinrh wants to merge 1 commit into
yvonnedevlinrh wants to merge 1 commit into
Conversation
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
jflowers
approved these changes
Aug 12, 2026
jflowers
left a comment
Contributor
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).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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