docs(docs): link repository files from /docs now that the repository is public

Aperta Adatta ai principianti
  • Qualcosa non va?
#462 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
nextjs, playwright, react, typescript
Ambito
documentation, frontend

Direzione di ricerca

Inizia da src/components/docs/doc-markdown.tsx:216, poi da src/lib/docs.ts:290 e dall’asserzione in src/lib/docs.test.ts:210; attualmente ogni commento indica il repository privato come motivo per rendere percorsi e riferimenti alle issue come testo semplice. Leggi prima i tre punti insieme e stabilisci la decisione caso per caso richiesta dall’issue, poi aggiorna il codice, i commenti e i motivi dei test in modo coordinato. Esegui src/lib/docs.test.ts e, se l’output renderizzato cambia, aggiorna e2e/docs.spec.ts con Playwright. Fatto significa che nessun commento o test cita la privacy e che ogni riferimento a un file o collega a GitHub oppure indica un motivo attuale.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area: docs documentation priority: P3 size: S

Context

The repository went public on 2026-11-15. Three places still rely on it being private, found in the #457 review:

  • src/components/docs/doc-markdown.tsx:216: "The repository is private, so a path is shown, never linked."
  • src/lib/docs.ts:290: a repository file "renders as text, not a link".
  • src/lib/docs.test.ts:210: "publishes no issue references" gives the private repository as its reason.

Plan

  1. Decide per case whether /docs should now link repository files and issues on GitHub, or keep rendering them as text for another reason.
  2. Update the code, the comments, and the tests to match.

Acceptance criteria

  • No comment or test reason says the repository is private.
  • Repository file references in /docs either link to the file on GitHub or say why they do not.
  • Playwright e2e: e2e/docs.spec.ts updated if links change.

Files and areas

src/components/docs/doc-markdown.tsx, src/lib/docs.ts, src/lib/docs.test.ts. Non-goals: the docs content itself.

Model: anthropic/claude-opus-5-5 | Reasoning effort: unknown

Lingua principale
TypeScript
Stelle
1
Fork
1
Merge medio
6h 56m
PR unite (30g)
136

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di eddiejaoude/StackDash

Tutte le issue di eddiejaoude/StackDash

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.