Skip to content

docs: add uf setup / uf init lifecycle section to Common Workflows - #251

Open
jflowers wants to merge 2 commits into
mainfrom
opsx/uf-init-setup-docs
Open

docs: add uf setup / uf init lifecycle section to Common Workflows#251
jflowers wants to merge 2 commits into
mainfrom
opsx/uf-init-setup-docs

Conversation

@jflowers

Copy link
Copy Markdown
Contributor

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:

  • Install cascade: What uf setup installs (4 tool categories), platform detection (Homebrew/dnf/curl), --dry-run preview
  • Project scaffolding: The 12-step uf init process at a conceptual level
  • Sub-tool initialization: Concurrent goroutine execution, Group A (Dewey) vs Group B (Specify, Replicator, OpenSpec, Gaze)
  • Re-initialization: --force flag behavior across both groups (v0.16.0 fix)
  • Guardrail injection: 4 command-specific variants with self-correction via correctness markers
  • Stale command warnings: Detection after uf.* namespace migration
  • Troubleshooting: Dewey hang on --force, stale command refs, RPM 404 errors on Fedora/RHEL

Cross-reference links added to Quick Start and Developer Guide pages.

How to Test

  1. Run npm run dev and navigate to http://localhost:1313/docs/getting-started/common-workflows/
  2. Verify the "uf setup / uf init Lifecycle" section appears in the sidebar TOC between "Environment Setup" and "Next Steps"
  3. Verify all subsections render correctly: Install Cascade, RPM Version Resolution, Project Scaffolding, Sub-tool Initialization, Re-initialization, Guardrail Injection, Stale Command Warnings, Troubleshooting
  4. Verify the Group A/B table renders with correct alignment
  5. Navigate to Quick Start -- verify the cross-reference link after the --dry-run sentence navigates to the lifecycle section anchor
  6. Navigate to Developer Guide -- verify the cross-reference link in Prerequisites navigates correctly
  7. Toggle dark mode and verify all content renders correctly

How to Demo

  1. Open the Common Workflows page and scroll to the new lifecycle section
  2. Walk through each subsection to show the progression from setup to init to troubleshooting
  3. Click the cross-reference links from Quick Start and Developer Guide to demonstrate navigation

Key Files Changed

content/docs/getting-started/ (site content)

  • common-workflows.md -- New lifecycle section (~86 lines), updated description frontmatter, explicit heading anchor
  • quick-start.md -- Cross-reference link to lifecycle section
  • developer.md -- Cross-reference link to lifecycle section

openspec/changes/uf-init-setup-docs/ (spec artifacts)

  • proposal.md -- Change motivation and scope
  • design.md -- 4 design decisions and risk analysis
  • specs/lifecycle-docs.md -- 4 requirements with BDD scenarios
  • tasks.md -- 7 implementation tasks (all complete)
  • .openspec.yaml -- Change metadata

This PR was generated by /uf.finale (AI-assisted).

yvonnedevlinrh
yvonnedevlinrh previously approved these changes Aug 27, 2026

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

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 build passes (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 both quick-start.md and developer.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:

  • --force re-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.md requirements 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 (per tasks.md 1.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

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Ready for Review 👀

Development

Successfully merging this pull request may close these issues.

3 participants