Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Docs plugin: velite content pipeline + read-only API

Đang mở
  • Có gì không ổn?
#446 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
api, backend, documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
TypeScript
Star
5
Fork
3
Merge trung bình
9 giờ 37 phút
Pull request đã merge (30 ngày)
157

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của NEARBuilders/everything-dev

Tất cả issue của NEARBuilders/everything-dev

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.