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

Docs plugin: velite content pipeline + read-only API

Aperta
  • Qualcosa non va?
#446 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à
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
api, backend, documentation

Direzione di ricerca

Start with the plugin template and the repository's beforeCompile escape hatch described in the issue, then read the authored config and existing oRPC handler conventions. Implementing this spans content compilation, API routes, plugin registration, and deploy behavior; the issue says it is blocked by #445. Done means the listed build, API, OpenAPI/MCP, and no-DB/no-secrets acceptance criteria pass.

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

Descrizione

ready-for-agent

Parent

#444

What to build

The docs plugin end to end on the read path: scaffolded from the template, a Velite content pipeline that compiles the repository's docs at build time, and a read-only oRPC router serving the compiled content. Users (and agents, via OpenAPI/MCP) can list and read the repo's documentation through the API.

  • velite.config.ts compiles docs/** and GLOSSARY.md (markdown format, raw body kept for client render; zod frontmatter: title, description, tags, order) — velite runs from a rspack beforeCompile hook appended via the ticket #1 escape hatch, so no hand-run velite step in dev or build
  • listPublished (paginated, tag/search filter) and getBySlug oRPC routes serve the compiled JSON; compiled content imports into the plugin source so the bundle is self-contained
  • Registered in the authored config with a UI mount; no database, no secrets
  • Handlers follow the repo convention: .effect() generators, services via yield* Tag, typed error shapes

Blocked by: #445

Acceptance criteria

  • every-plugin build (and the deploy train) compiles content with no manual velite invocation; the velite output directory is gitignored
  • GET /api/rpc/docs/listPublished returns the repository's docs with pagination metadata
  • GET /api/rpc/docs/getBySlug returns a real ADR or glossary entry's raw markdown + metadata
  • The docs routes appear in the OpenAPI spec and MCP tools
  • Plugin definition carries no DB layer and no secrets
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.