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

Public docs UI — browse + read

Đang mở
  • Có gì không ổn?
#447 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
react, typescript
Lĩnh vực
documentation, frontend

Hướng nghiên cứu

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.

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

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.