docs: document GitHub template workflow

[michaelmwu]

Summary

• Document GitHub template repository usage for 508 Devkit.
• Add a generated-repo template selection checklist so users and agents prune irrelevant stacks, extras, docs, workflows, and example identifiers.
• Update README, agent walkthrough, interface notes, template proposal, and the bundled 508-devkit skill to describe the same pick-and-choose workflow.

Notes

• The 508-dev/508-devkit repository setting has already been marked as a GitHub template repository; this PR documents the intended workflow in the repo contents.
• This is intentionally not a generated-app promise: template users should do a first cleanup PR before feature work.

Validation

• Ran ./scripts/check-all.sh
• Ran git diff --check

Risk

• Low risk, docs and agent workflow guidance only.

Screenshots

Not applicable.

Summary by CodeRabbit

Release Notes

• Documentation
  • Clarified repository as a reference template baseline with improved Quickstart instructions.
  • Added comprehensive guidance for using GitHub's "Use this template" feature.
  • Enhanced agent workflow documentation with detailed steps for template selection and cleanup.
  • Expanded best practices for selective stack adoption and repository customization.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates documentation across the repository to establish comprehensive GitHub template usage guidance. Changes clarify the repository's role as a reference template baseline, introduce a new GitHub template creation guide with agent instructions, expand existing documentation and quickstart workflows, and update agent/skill processes to handle template-generated repositories.

Changes

GitHub Template Usage and Guidance

Layer / File(s)	Summary
Template baseline concept and positioning README.md	Repository introduction is reworded to explicitly define the repository as a reference/template baseline for project shaping. "Pick-And-Choose Stacks And Extras" framing is strengthened to clarify the repo is a template source with conflicting files, not an installable preset or final generated app.
GitHub template usage guide and mode documentation docs/github-template.md, docs/template-proposal.md	New docs/github-template.md file documents step-by-step GitHub template selection and remediation flow with an agent prompt for initial template pass. docs/template-proposal.md introduction is reformatted to explicitly explain GitHub template behavior and first-change expectations. A new "GitHub Template Mode" section documents generated-repo hygiene practices and selection processes.
Repository template interface documentation update docs/interfaces.md	"Repository Template" guidance is expanded to clarify that GitHub's "Use this template" button copies the full default branch file tree, with instructions to immediately run a template selection pass and delete unnecessary files before starting product work.
README quickstart and setup instructions README.md	Quickstart section is expanded with "Create A New Repository" subsection covering template creation and first prompt steps, plus strengthened "Normalize An Existing Repository" guidance. "Read Next" checklist gains additional doc references and explicit setup commands. Agent Notes are extended with explanation of how GitHub-generated repos start with the full tree and require template-selection pruning in the first PR.
Agent workflow and SKILL documentation docs/agent-walkthrough.md, skills/508-devkit/SKILL.md	"Expected Agent Flow" section is updated to emphasize applying the smallest useful set of files and clarify subsequent template-cleanup steps. SKILL.md is amended with guidance for GitHub-template-generated repositories to treat first changes as template selection pass, and a workflow step is added requiring deletion of unselected stacks, extras, workflows, example names, and docs before product feature work.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

A template needs gentle guidance true,
Select each stack and pick what's new,
Prune the rest with careful care,
And build your project everywhere! 🐰✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main objective of the changeset: documenting the GitHub template workflow. All file changes consistently address this central theme.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch michaelmwu/template-repo

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

Documents how to use 508 Devkit as a GitHub template repository, emphasizing that template-generated repos should do an initial “template selection pass” to prune irrelevant stacks/extras/docs/workflows before feature work.

Changes:

• Adds guidance across README + agent docs to treat GitHub template-generated repos as a bootstrap workspace requiring an initial cleanup PR.
• Introduces a dedicated cleanup/checklist doc: docs/github-template.md.
• Aligns the bundled skills/508-devkit skill and walkthrough docs with the same template-selection workflow.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
skills/508-devkit/SKILL.md	Adds template-generated repo guidance and a cleanup step in the workflow.
README.md	Updates quickstart with “Create from template” flow and links to the new checklist doc.
docs/template-proposal.md	Documents “GitHub Template Mode” and the initial selection/pruning expectation.
docs/interfaces.md	Adds template usage as a first-class repo interface + selection-pass guidance.
docs/github-template.md	New checklist doc describing the intended template generation + pruning workflow.
docs/agent-walkthrough.md	Adds a template-specific prompt and includes pruning as an explicit agent step.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/agent-walkthrough.md`:
- Around line 28-30: Update the template-cleanup instructions in Step 6 of
docs/agent-walkthrough.md to explicitly include deleting unselected "workflows"
(CI workflow files) along with stacks, extras, example app names, and docs so it
matches the template-selection flow described in docs/github-template.md; change
the wording in the Step 6 text to mention "workflows" so generated repos do not
retain irrelevant CI files.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ddf9d3d8-707b-45ad-8255-bed6e81876fd

📥 Commits

Reviewing files that changed from the base of the PR and between fabd4e3 and fa55b3b.

📒 Files selected for processing (6)

• README.md
• docs/agent-walkthrough.md
• docs/github-template.md
• docs/interfaces.md
• docs/template-proposal.md
• skills/508-devkit/SKILL.md

[coderabbitai]

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Include “workflows” in the template-cleanup step for consistency.

Step 6 omits workflows, but the template-selection flow in docs/github-template.md explicitly includes deleting unselected placeholder workflows. This mismatch can cause generated repos to keep irrelevant CI files.

Suggested wording update

-6. If the repo was generated from the GitHub template, delete unselected stacks,
-   extras, example app names, and docs that do not describe the target project.
+6. If the repo was generated from the GitHub template, delete unselected stacks,
+   extras, workflows, example app names, and docs that do not describe the
+   target project.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	6. If the repo was generated from the GitHub template, delete unselected stacks,
	extras, example app names, and docs that do not describe the target project.
	7. Run focused validation.
	6. If the repo was generated from the GitHub template, delete unselected stacks,
	extras, workflows, example app names, and docs that do not describe the
	target project.
	7. Run focused validation.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/agent-walkthrough.md` around lines 28 - 30, Update the template-cleanup
instructions in Step 6 of docs/agent-walkthrough.md to explicitly include
deleting unselected "workflows" (CI workflow files) along with stacks, extras,
example app names, and docs so it matches the template-selection flow described
in docs/github-template.md; change the wording in the Step 6 text to mention
"workflows" so generated repos do not retain irrelevant CI files.