Skip to content

Commit 73848a1

Browse files
committed
docs: add onboarding outreach and feedback templates
1 parent b9eab9f commit 73848a1

6 files changed

Lines changed: 148 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
blank_issues_enabled: true
22
contact_links:
3+
- name: Manual onboarding feedback form
4+
url: https://github.com/dtsong/my-opencode-codex-setup/blob/main/docs/onboarding-feedback.md
5+
about: Use this if a tester cannot submit a GitHub issue directly.
36
- name: Discussions
47
url: https://github.com/dtsong/my-opencode-codex-setup/discussions
58
about: Ask open-ended questions and share ideas.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Onboarding feedback
3+
about: Share first-time setup experience for council-lite onboarding validation.
4+
title: "onboarding: "
5+
labels: ["question"]
6+
assignees: []
7+
---
8+
9+
## Participant
10+
11+
- Alias/name:
12+
- Date:
13+
14+
## Environment
15+
16+
- OS:
17+
- Shell:
18+
- Repo tag/commit tested:
19+
20+
## Commands Run
21+
22+
```text
23+
Paste exact commands run.
24+
```
25+
26+
## Outcome
27+
28+
- Result: success | partial | fail
29+
- Time-to-first-success (minutes):
30+
31+
## Friction Points
32+
33+
What was confusing, slow, or unclear?
34+
35+
## Errors/Output
36+
37+
```text
38+
Paste relevant logs/errors.
39+
```
40+
41+
## Suggestions
42+
43+
What would make onboarding easier for a first-time user?
44+
45+
## Recommendation
46+
47+
- Would you recommend this onboarding flow to a friend? yes | no | maybe

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,5 @@ See `docs/workflows-playbook.md` for usage patterns.
106106
- practical usage examples in `examples/`
107107
- release checklist in `docs/release-checklist.md`
108108
- launch checklist in `docs/open-source-launch.md`
109+
- friend outreach message in `docs/friend-outreach-template.md`
110+
- onboarding feedback channels in `docs/onboarding-feedback.md`

docs/friend-outreach-template.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Friend Outreach Template
2+
3+
Use this message when inviting friends to help validate onboarding.
4+
5+
## Copy/Paste Message
6+
7+
Hey! I am testing onboarding for my OpenCode/Codex setup and would love your help.
8+
9+
Goal: verify whether a new user can get from clone to a successful council-lite run quickly and clearly.
10+
11+
If you are up for it, please run these steps:
12+
13+
```bash
14+
git clone https://github.com/dtsong/my-opencode-codex-setup.git
15+
cd my-opencode-codex-setup
16+
./install.sh --conflict-policy skip --profiles core,council-lite
17+
./scripts/council-lite.sh run "Onboarding validation run"
18+
./scripts/council-lite.sh list
19+
./scripts/validate-council-lite.sh --latest
20+
./install.sh --uninstall
21+
```
22+
23+
Then share feedback in one of two ways:
24+
25+
1. Open a GitHub issue using the "Onboarding feedback" template
26+
2. Send me the manual feedback form in `docs/onboarding-feedback.md`
27+
28+
What I need from you:
29+
- OS + shell
30+
- whether it succeeded (`success` | `partial` | `fail`)
31+
- time-to-first-success (minutes)
32+
- any confusion points or rough edges
33+
- what would make this easier for new users
34+
35+
Thank you - this feedback directly decides when council-lite can move from beta to stable.

docs/onboarding-feedback.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Onboarding Feedback Guide
2+
3+
This guide provides two fast channels for onboarding feedback:
4+
5+
1. GitHub issue template (preferred)
6+
2. Manual form (copy/paste)
7+
8+
Related tracker issue: `#6`
9+
10+
## Option 1: GitHub Issue Template (Preferred)
11+
12+
Open a new issue and choose **Onboarding feedback**:
13+
14+
- URL: `https://github.com/dtsong/my-opencode-codex-setup/issues/new/choose`
15+
- Template file: `.github/ISSUE_TEMPLATE/onboarding_feedback.md`
16+
17+
Why preferred:
18+
- keeps feedback structured and searchable
19+
- makes follow-up actions easier to triage
20+
- links directly to onboarding validation tracking
21+
22+
## Option 2: Manual Feedback Form
23+
24+
Copy and fill this template if someone cannot use GitHub issues:
25+
26+
```markdown
27+
## Onboarding Feedback
28+
29+
- Participant alias:
30+
- Date:
31+
- OS:
32+
- Shell:
33+
- Repo commit/tag used:
34+
35+
### Commands Run
36+
```text
37+
Paste exact commands run.
38+
```
39+
40+
### Result
41+
- Outcome: success | partial | fail
42+
- Time-to-first-success (minutes):
43+
44+
### Friction Points
45+
-
46+
47+
### Errors/Output (if any)
48+
```text
49+
Paste relevant logs or errors.
50+
```
51+
52+
### Suggested Improvements
53+
-
54+
55+
### Would you recommend this onboarding flow?
56+
- yes | no | maybe
57+
```
58+
59+
If feedback is collected manually, add it as a comment on issue `#6` so it counts toward the 3-confirmation gate.

docs/open-source-launch.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,11 @@ This is separate from `docs/release-checklist.md`, which is for recurring versio
3232
- [ ] GitHub release drafted with highlights and known limitations
3333
- [ ] launch announcement copy prepared (X/LinkedIn/GitHub Discussion)
3434
- [ ] first 3-5 starter issues prepared for contributors
35+
- [ ] friend outreach template is ready (`docs/friend-outreach-template.md`)
3536

3637
## Post-launch Follow-up
3738

3839
- [ ] monitor first-week issues and triage daily
3940
- [ ] collect onboarding friction points from early users
41+
- [ ] onboarding feedback issue template/manual form are active (`docs/onboarding-feedback.md`)
4042
- [ ] publish first-week patch release plan

0 commit comments

Comments
 (0)