Skip to content

Commit 722068f

Browse files
hsnice16claude
andcommitted
docs: sync methodology FAQ + README layout with shipped surface
- Methodology FAQ #8: "periodic refresh" → "webhook-driven rescoring on every push" to match tasks/0.6.0/01-webhook-rescoring.md and lib/roadmap.ts. - README Layout: add /about, /action, /skill, /package, /llms.txt pages and expand /api summary (score / badge / package endpoints) — all shipped across 0.3.0–0.5.0. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 0da7ca2 commit 722068f

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,13 +137,18 @@ Run the unit tests with `bun run test` (uses `node --test` + `tsx`; requires Nod
137137
app/ Next.js App Router — pages + API + SEO
138138
layout.tsx root layout, root metadata (OG + Twitter cards)
139139
page.tsx leaderboard
140-
repo/[id]/ repo detail (includes generateMetadata for shareable titles)
140+
repo/[id]/ repo detail (generateMetadata + per-repo OG image)
141141
methodology/ how scoring works today
142142
roadmap/ upcoming versions (from lib/roadmap.ts)
143143
changelog/ what's shipped (from lib/changelog.ts)
144-
api/ repos + repo/[id] JSON routes
144+
about/ independent project, no vendor affiliation (footer-linked, E-E-A-T)
145+
action/ PR-diff GitHub Action explainer + install snippet
146+
skill/ agent-skill explainer + install command
147+
package/ registry → repo lookup (form + per-package state pages)
148+
api/ /repos, /repo/[id], /score, /badge/<host>/<owner>/<name>, /package/<registry>/<name>
145149
robots.ts /robots.txt — allows "/", blocks "/api/"
146150
sitemap.ts /sitemap.xml — static routes + every repo
151+
llms.txt/ markdown manifest for LLM crawlers
147152
globals.css Tailwind import + @theme tokens
148153
components/ React components (Tailwind-styled)
149154
lib/

app/methodology/page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ const FAQ = [
4747
},
4848
{
4949
q: "How often is the data refreshed?",
50-
a: "Manually for now — repositories are re-scored when the seed list changes or the rubric is updated. Automated periodic refresh is planned for v0.6.0.",
50+
a: "Manually for now — repositories are re-scored when the seed list changes or the rubric is updated. Webhook-driven rescoring on every push is planned for v0.6.0.",
5151
},
5252
{
5353
q: "Which forges are supported?",

0 commit comments

Comments
 (0)