Commit 4c5d4c6
committed
Step-by-step usage guide + HowTo schema page + one-shot GitHub setup script
Three additions, all aligned with the user's "make it easy to use, add all
details for how to use this app step by step" ask:
1. README.md — new "How to use OpenAdKit — step-by-step" section
- Inserted between Screenshots and Who's-it-for (highest read-position
after the install + screenshots block).
- 5 numbered steps with time estimates:
Step 1 (30s-5min): Install — Hosted OR Local path
Step 2 (2 min): Pick AI provider + paste key (with direct
signup links to Groq, Gemini, Claude)
Step 3 (3 min): Add first brand from URL — explains what gets
extracted (30+ fields)
Step 4 (1 min): Generate first ad on Meta — what you get +
the schema retry layer + Cmd+Enter shortcut
Step 5 (3-5 min): Score + optimize + ship — 5-lever Creative
Score + tier verdict + 4 follow-up optimizers
- "What to try next" closer pointing at Steal & Beat, Content Calendar,
Campaign Kit, Frameworks Trainer.
- Top-of-README nav anchor added.
2. app/how-to-use/page.tsx — hosted-app version
- Same 5 steps but with hyperlinked internal navigation (sidebar TOC,
scroll-mt-16 jump anchors, in-app links to /optimize/creative-score,
/research/competitors, /learn/frameworks, etc.)
- HowTo JSON-LD schema emitted in SSR <head>. Google Rich Results
surfaces step-by-step previews in search for queries like "how to
use openadkit" and "openadkit tutorial". totalTime: PT10M,
estimatedCost: $0.
- Added to sitemap (priority 0.9), robots.txt Allow list, smoke
suite (now 49 routes).
- Page-level <title> + canonical + OG description tuned for the
"openadkit tutorial" / "how to use ai marketing tool" intent.
3. scripts/setup-github.cjs — one-shot repo metadata setter
- User asked: "add descriptions and topics all things yourself". The
repo description / topics / homepage / features can only be set via
authenticated GitHub API (gh CLI), so I built a script that does it
all in one command after the user runs `gh auth login` once.
- Sets: description (with the picked SEO title), homepage URL,
20 topics (ai-marketing, jasper-alternative, adcreative-alternative,
anyword-alternative, byok, open-source, etc.), and feature toggles
(issues + discussions on, wiki + projects off).
- Idempotent — safe to re-run.
- Surfaces the manual social-preview upload step at the end (GitHub
doesn't expose social-preview image upload via REST API as of now).
- npm run setup:github wraps it.
Verified: tsc clean, 77/77 unit tests, next build clean (76 routes +
/how-to-use registered as static), 49/49 Playwright smoke pass.1 parent f2e6bf6 commit 4c5d4c6
7 files changed
Lines changed: 695 additions & 0 deletions
File tree
- app
- how-to-use
- public
- scripts
- tests
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| 27 | + | |
27 | 28 | | |
28 | 29 | | |
29 | 30 | | |
| |||
117 | 118 | | |
118 | 119 | | |
119 | 120 | | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
120 | 210 | | |
121 | 211 | | |
122 | 212 | | |
| |||
0 commit comments