Public docs UI — browse + read
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 55/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- react, typescript
- Área
- documentation, frontend
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.naventry 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-testidselectors follow the browser-regression conventions
Blocked by: #446
Acceptance criteria
-
/docslists 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
publicmount (no gate); compose path-collision guard stays green -
pnpm run typecheckandpnpm run lintpass
- Lenguaje dominante
- TypeScript
- Estrellas
- 5
- Forks
- 3
- Merge medio
- 11 h 8 min
- PR fusionados (30 d)
- 90
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de NEARBuilders/everything-dev
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
NEARBuilders/everything-dev#400 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
NEARBuilders/everything-dev#507 ·
Los mantenedores suelen responder en 1 día
-
bug needs-triage
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
NEARBuilders/everything-dev#496 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
NEARBuilders/everything-dev#493 ·
Los mantenedores suelen responder en 1 día
-
ready-for-human
Dificultad 5/5 Más de una semana Aptitud para principiantes 15/100
NEARBuilders/everything-dev#491 ·
Los mantenedores suelen responder en 1 día
Todos los issues de NEARBuilders/everything-dev
Issues similares
-
[BUG] rag: sentence content can cross the reported sentence boundariesPosiblemente ocupada @LJK-ikun la tomó hoy. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
bug needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 1 día
-
README: the Resource URI Schemas example's file://documents/* pattern only matches that literal URIAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
platformatic/mcp#361 ·
Los mantenedores suelen responder en 1 día
-
frontend
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Push: sem service worker ou sem VAPID, o interruptor de Notificações fica ligado sem avisar nadaAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
melgarafael/DeskcommCRM#3164 ·
Los mantenedores suelen responder en 1 día