Skip to content

docs: update uf init docs to reflect --no-embeddings default - #232

Open
yvonnedevlinrh wants to merge 1 commit into
unbound-force:mainfrom
yvonnedevlinrh:opsx/uf-init-no-embeddings-docs
Open

docs: update uf init docs to reflect --no-embeddings default#232
yvonnedevlinrh wants to merge 1 commit into
unbound-force:mainfrom
yvonnedevlinrh:opsx/uf-init-no-embeddings-docs

Conversation

@yvonnedevlinrh

Copy link
Copy Markdown
Contributor

Summary

Updates documentation across 4 content pages to reflect the upstream
behavioral change from unbound-force/unbound-force#321: uf init --force
now passes --no-embeddings to dewey index, deferring embedding
generation for faster initialization.

Closes #211

Changes

File What changed
content/docs/getting-started/knowledge.md Step 3 of "What uf init Creates" now shows dewey index --no-embeddings with cross-reference to Global CLI Flags table
content/docs/getting-started/developer.md --force flag table row and Sub-Tool Initialization section both note --no-embeddings deferral
content/docs/reference/cli.md --force flag description updated to mention --no-embeddings
content/docs/getting-started/common-workflows.md Setup workflow description updated to dewey index --no-embeddings

All pages include guidance to run dewey index separately to generate
embeddings for semantic search.

The blog post (dewey-knowledge-retrieval.md) was reviewed and left
unchanged — its mention of uf init is general enough to remain accurate.

Spec artifacts

OpenSpec change: openspec/changes/uf-init-no-embeddings-docs/

  • proposal.md — motivation, affected pages, constitution alignment
  • specs/content-accuracy.md — delta requirements with Given/When/Then scenarios
  • design.md — 4 decisions (in-place edits, DRY cross-refs, skip release notes, minimal blog update)
  • tasks.md — 5 content tasks + 3 verification tasks, all complete

Review council

6/6 APPROVE (adversary, architect, guard, testing, sre, curator). No
REQUEST CHANGES findings.

Verification

  • npm run build passes (140 pages)
  • Grep sweep: all uf init + dewey index references checked, no stale content
  • Constitution alignment: Content Accuracy (I), Minimal Footprint (II), Visitor Clarity (III) all PASS

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
@yvonnedevlinrh
yvonnedevlinrh requested a review from a team August 12, 2026 15:34
@yvonnedevlinrh yvonnedevlinrh self-assigned this Aug 12, 2026
@yvonnedevlinrh yvonnedevlinrh added release-ready Ready to ship with the next uf release next-release Targeted for inclusion in next release but can be deferred if needed labels Aug 12, 2026
@yvonnedevlinrh yvonnedevlinrh moved this to Ready for Review 👀 in Unbound Force Planning Aug 12, 2026

@jflowers jflowers left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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).

@jflowers jflowers moved this from Ready for Review 👀 to In Review 🏁 in Unbound Force Planning Aug 12, 2026
@yvonnedevlinrh yvonnedevlinrh self-assigned this Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

next-release Targeted for inclusion in next release but can be deferred if needed release-ready Ready to ship with the next uf release

Projects

Status: In Review 🏁

Development

Successfully merging this pull request may close these issues.

docs: uf init --force no longer hangs on Dewey reindexin

3 participants