Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Public docs UI — browse + read

Aperta
  • Qualcosa non va?
#447 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à
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
55/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
react, typescript
Ambito
documentation, frontend

Direzione di ricerca

Start by resolving the #446 blocker and reading the docs plugin's public mount and route composition conventions. Implement the _public/docs/ index and _public/docs/$slug/ read route, using the shared MarkdownRenderer; keep manifest.gen.json and routeConfig.gen.ts generated-only. Done when docs appear with tags and sidebar navigation, a real doc renders with code highlighting in the app shell, and typecheck, lint, and the path-collision guard pass.

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

Descrizione

ready-for-agent

Parent

#444

What to build

The docs plugin's UI surface under the public mount: a browsable index and a read route that render the repository's docs in the app shell, gate-free. Content changes flow from repo merges → deploy → recompiled content — no runtime state.

  • _public/docs/ index (list with tags; staticData.nav entry so it appears in the composed sidebar) and _public/docs/$slug/ read route
  • One shared MarkdownRenderer (react-markdown + shiki for code highlighting) — the same component any future draft-editor preview will reuse, giving preview parity by construction
  • Route/manifest generation (manifest.gen.json, routeConfig.gen.ts) stays generated-only; data-testid selectors follow the browser-regression conventions

Blocked by: #446

Acceptance criteria

  • /docs lists the repository's docs with tags; the sidebar shows the nav entry
  • /docs/<slug> renders a real doc's markdown with code highlighting, inside the app shell
  • Routes mount under the public mount (no gate); compose path-collision guard stays green
  • pnpm run typecheck and pnpm run lint pass
Lingua principale
TypeScript
Stelle
5
Fork
3
Merge medio
12h 42m
PR unite (30g)
72

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 NEARBuilders/everything-dev

Tutte le issue di NEARBuilders/everything-dev

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.