Skip to content

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

Merged
yvonnedevlinrh merged 2 commits into
unbound-force:mainfrom
yvonnedevlinrh:opsx/uf-init-no-embeddings-docs
Aug 26, 2026
Merged

docs: update uf init docs to reflect --no-embeddings default#232
yvonnedevlinrh merged 2 commits 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

@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 previously approved these changes 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
@jflowers

Copy link
Copy Markdown
Contributor

Upstream Implementation Verification

Upstream PR: unbound-force/unbound-force#321 (merged 2026-07-01)
Verification source: internal/scaffold/scaffold.go at HEAD on main

Claim-by-Claim Verification

Claim File Verdict Evidence
Fresh init runs dewey index --no-embeddings knowledge.md, common-workflows.md CONFIRMED scaffold.go:1592opts.ExecCmd("dewey", "index", "--no-embeddings") in fresh-init path
--force re-indexes with --no-embeddings developer.md, cli.md CONFIRMED scaffold.go:1614opts.ExecCmd("dewey", "index", "--no-embeddings") in opts.Force path
Guidance to run dewey index separately for embeddings all 4 pages CONFIRMED scaffold.go:1603,1625 — both paths print "Run 'dewey index' separately to generate embeddings for semantic search."
--no-embeddings flag already documented in Global CLI Flags table knowledge.md cross-ref CONFIRMED PR correctly references existing docs rather than duplicating (design decision D2)
Blog post left unchanged (general mention, not misleading) dewey-knowledge-retrieval.md CONFIRMED Design decision D4 applied correctly — point-in-time blog content remains accurate

All 4 content file changes and the blog-post-skip decision are accurate against the implementation at HEAD. Tests in scaffold_test.go (lines 2307, 4090-4098, 4371) also confirm the --no-embeddings expectation.

Command Naming

No slash commands are referenced in this PR. The uf init CLI command name is correct. No naming discrepancies.

Adjacent Open Issues

Issue Title Disposition
#211 uf init --force no longer hangs on Dewey reindexing Directly closed by this PR — consistent
#245 Document uf init --force behavior for Group B sub-tools No conflict#245 covers a different scope (specify, replicator, openspec, gaze). This PR's --force description is limited to the Dewey --no-embeddings aspect, which is correct. When #245 lands, the --force docs will expand but nothing in this PR contradicts or is superseded by #245.
#203 Concurrent sub-tool initialization in uf init No conflict — this PR describes Dewey-specific behavior without claiming sequential execution order. When #203 lands (documenting goroutine concurrency from #251), the text will be additive.

Summary

All 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 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

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-flags verified ✓
  • 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).

jflowers added a commit that referenced this pull request Aug 24, 2026
…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
jflowers added a commit that referenced this pull request Aug 24, 2026
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).
yvonnedevlinrh added a commit to yvonnedevlinrh/website that referenced this pull request Aug 25, 2026
… 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
@yvonnedevlinrh
yvonnedevlinrh force-pushed the opsx/uf-init-no-embeddings-docs branch from 8020525 to 724ac0f Compare August 25, 2026 12:59
@yvonnedevlinrh

Copy link
Copy Markdown
Contributor Author

Thanks for the review! Addressed below.

[MEDIUM] Stray .uf/replicator/replicator.log — Fixed in 724ac0f. Removed from tracking (git rm --cached) and added .uf/replicator/*.log to .gitignore (also added .uf/feedback/ to prevent local triage-cache artifacts from being committed). Aligns with the existing .uf/dewey/*.log precedent and the Zero-Waste Mandate.

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

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

lgtm

@yvonnedevlinrh
yvonnedevlinrh merged commit aae0310 into unbound-force:main Aug 26, 2026
@yvonnedevlinrh
yvonnedevlinrh deleted the opsx/uf-init-no-embeddings-docs branch August 26, 2026 09:03
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