docs: generate owner-focused site README #264

Merged

erik merged 1 commit from docs/task-d24d1404-owner-readme into main

2026-07-20 08:12:23 -05:00

erik commented

2026-07-20 08:04:52 -05:00

Owner

Summary

Generate a purpose-built owner README during slug init so onboarding starts inside the generated repository and covers setup, first posts, and deployment.

Task

task-d24d1404

Changes

Add a generated-site README template with ordered owner setup and explicit Slugkit source attribution.
Add direct CLI and Markdown-import draft review and publish tutorials.
Replace fragile source README paragraph transformations with placeholder rendering.
Verify generated onboarding order, commands, and absence of maintainer-only instructions.

Testing

Unit tests added/updated
Manual generated-output inspection performed
./scripts/pre-pr.sh

Checklist

./scripts/pre-pr.sh passes
Documentation updated
No unrelated changes included

## Summary Generate a purpose-built owner README during `slug init` so onboarding starts inside the generated repository and covers setup, first posts, and deployment. ## Task task-d24d1404 ## Changes - Add a generated-site README template with ordered owner setup and explicit Slugkit source attribution. - Add direct CLI and Markdown-import draft review and publish tutorials. - Replace fragile source README paragraph transformations with placeholder rendering. - Verify generated onboarding order, commands, and absence of maintainer-only instructions. ## Testing - [x] Unit tests added/updated - [x] Manual generated-output inspection performed - [x] `./scripts/pre-pr.sh` ## Checklist - [x] `./scripts/pre-pr.sh` passes - [x] Documentation updated - [x] No unrelated changes included

erik added 1 commit

2026-07-20 08:04:52 -05:00

docs: generate owner-focused site readme

CI / build-lint-test (pull_request) Successful in 2m16s

Details

34f4e67fea

Task: #task-d24d1404

erik commented

2026-07-20 08:08:18 -05:00

Author

Owner

Review update

PR: #264 open; CI run #412 passed.
Result: approved.
Scope: Replaces fragile generated README paragraph rewrites with a dedicated owner-facing template and focused output assertions.

Acceptance criteria

Met: Generated README starts after initialization and contains no instruction to run slug init again.
Met: Required first-run steps are ordered from dependency installation through verification.
Met: Required setup, optional federation, and deployment are clearly separated.
Met: Owner login and explicit /setup actor creation match the first-run gate.
Met: Direct CLI tutorial creates a draft, inspects it, and publishes explicitly.
Met: Markdown tutorial documents required frontmatter, imports a draft, inspects it, and publishes explicitly.
Met: Every tutorial command names the target site and explains draft versus published state.
Met: Generated-output tests verify sequence, commands, and absence of source-template instructions.

Quality

Blocking issues: none.
Warnings: none.
Verification: ./scripts/pre-pr.sh and Forgejo CI passed.

Final verdict: approved.

### Review update - PR: #264 open; CI run #412 passed. - Result: approved. - Scope: Replaces fragile generated README paragraph rewrites with a dedicated owner-facing template and focused output assertions. #### Acceptance criteria - **Met:** Generated README starts after initialization and contains no instruction to run `slug init` again. - **Met:** Required first-run steps are ordered from dependency installation through verification. - **Met:** Required setup, optional federation, and deployment are clearly separated. - **Met:** Owner login and explicit `/setup` actor creation match the first-run gate. - **Met:** Direct CLI tutorial creates a draft, inspects it, and publishes explicitly. - **Met:** Markdown tutorial documents required frontmatter, imports a draft, inspects it, and publishes explicitly. - **Met:** Every tutorial command names the target site and explains draft versus published state. - **Met:** Generated-output tests verify sequence, commands, and absence of source-template instructions. #### Quality - Blocking issues: none. - Warnings: none. - Verification: `./scripts/pre-pr.sh` and Forgejo CI passed. **Final verdict: approved.**

erik merged commit ad1ab2379e into main

2026-07-20 08:12:23 -05:00

erik deleted branch docs/task-d24d1404-owner-readme

2026-07-20 08:12:23 -05:00

erik referenced this pull request from a commit

2026-07-20 08:12:24 -05:00

Merge pull request 'docs: generate owner-focused site README' (#264) from docs/task-d24d1404-owner-readme into main