docs: add uf setup / uf init lifecycle section to Common Workflows - #251
docs: add uf setup / uf init lifecycle section to Common Workflows#251jflowers wants to merge 2 commits into
Conversation
yvonnedevlinrh
left a comment
There was a problem hiding this comment.
Review: APPROVE ✅
Well-scoped, documentation-only PR that consolidates scattered uf setup / uf init operational knowledge into a coherent lifecycle section on the Common Workflows page.
Verification
- Build:
npm run buildpasses (140 pages, 0 errors) - Anchors: All 54 in-page + cross-page anchor links resolve in the built HTML — including the explicit
{#uf-setup-uf-init-lifecycle}anchor referenced from bothquick-start.mdanddeveloper.md - Frontmatter: Complete on all modified content files
- Heading hierarchy: Valid (H2 → H3 → H4, no skipped levels)
Content Accuracy
The two highest-risk technical claims were cross-checked against upstream sources:
--forcere-initializes Group B sub-tools (v0.16.0 fix) — matches issue #479 / PR #524 ✓- RPM independent version resolution via
gh release view— matches PR #461 (repo/semver/length validation) ✓
No fabrication or overstatement. Content is accurately sourced from the referenced issues/PRs (#203, #210, #211, #222, #223, #225, #236, #245, #232, #244).
Compliance
- Zero-Waste Mandate: No dead links or orphaned anchors
- Neighborhood Rule: Additive anchors only; no nav/menu/layout/SCSS changes; full-site build regression-free
- Requirement coverage: All
specs/lifecycle-docs.mdrequirements satisfied
Findings
- [LOW]
common-workflows.md: The prose says "12-step scaffolding sequence" but the following list has 7 bullets. This is intentional conceptual summarization (pertasks.md1.1), not fabrication, but a reader may try to count 12 bullets. Consider rewording to "a 12-step internal sequence, summarized here as:". Non-blocking.
No security, constitution, or alignment blockers.
- Document the full uf setup install cascade, uf init 12-step scaffolding process, sub-tool initialization (Group A/B), --force re-initialization, guardrail injection, and stale command warnings - Add troubleshooting subsection for common issues (Dewey hang, stale refs, RPM 404 errors) - Add cross-reference links from Quick Start and Developer Guide - Source content from 8 resolved GitHub issues (#203, #210, #211, #222, #223, #225, #236, #245) - Include OpenSpec change artifacts (proposal, design, spec, tasks) Assisted-by: claude-opus-4 Generated with AI assistance (claude-opus-4)
…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
ed3667d to
928445c
Compare
yvonnedevlinrh
left a comment
There was a problem hiding this comment.
Review Update: REQUEST CHANGES
My earlier APPROVE was against commit ed3667d. SInce then there were two new commits (159252e + 928445c). The commits now in the PR introduced the blocking findings below
Findings
| Severity | Location | Finding | Fix |
|---|---|---|---|
| HIGH | common-workflows.md:61 & :97 |
Duplicate ### Structured PR Descriptions heading (introduced by 928445c). Hugo emits duplicate TOC anchors (#structured-pr-descriptions and #structured-pr-descriptions-1), producing user-visible navigation noise and redundant content. |
Remove the duplicate section. |
| MEDIUM | common-workflows.md frontmatter |
description is 166 characters, exceeding Hugo's 160-char SEO limit and triggering a build warning: WARN Description too long. Was ~150 chars in the reviewed commit. |
Trim description to ≤160 characters. |
| MEDIUM | common-workflows.md |
The duplicated PR-description content is redundant published content, violating the Zero-Waste Mandate (AGENTS.md Behavioral Constraint 1). Same root cause as the HIGH finding. | Remove the duplicate (resolved by the HIGH fix). |
Recommendation
Both MEDIUM findings and the HIGH finding stem from the post-approval commit 928445c.
Review generated with AI assistance.
Summary
Adds a dedicated "uf setup / uf init Lifecycle" section to the Common Workflows page, documenting the full initialization lifecycle that was previously scattered across 8 resolved GitHub issues (#203, #210, #211, #222, #223, #225, #236, #245) with no website coverage.
The new section covers:
uf setupinstalls (4 tool categories), platform detection (Homebrew/dnf/curl),--dry-runpreviewuf initprocess at a conceptual level--forceflag behavior across both groups (v0.16.0 fix)uf.*namespace migration--force, stale command refs, RPM 404 errors on Fedora/RHELCross-reference links added to Quick Start and Developer Guide pages.
How to Test
npm run devand navigate to http://localhost:1313/docs/getting-started/common-workflows/--dry-runsentence navigates to the lifecycle section anchorHow to Demo
Key Files Changed
content/docs/getting-started/ (site content)
common-workflows.md-- New lifecycle section (~86 lines), updated description frontmatter, explicit heading anchorquick-start.md-- Cross-reference link to lifecycle sectiondeveloper.md-- Cross-reference link to lifecycle sectionopenspec/changes/uf-init-setup-docs/ (spec artifacts)
proposal.md-- Change motivation and scopedesign.md-- 4 design decisions and risk analysisspecs/lifecycle-docs.md-- 4 requirements with BDD scenariostasks.md-- 7 implementation tasks (all complete).openspec.yaml-- Change metadataThis PR was generated by /uf.finale (AI-assisted).