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

Author the docs plugin's own documentation (dogfood)

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

Hướng nghiên cứu

Read the docs plugin implementation and its Velite pipeline, then follow the repository's docs conventions and GLOSSARY.md. Author the plugin guide in the docs tree with the requested frontmatter fields, covering the plugin, build process, adding docs, and OpenAPI/MCP access. Verify the page renders on /docs; completion also depends on blocked issue #447.

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 documents itself, through its own pipeline: author its user- and agent-facing documentation as markdown in the repository's docs tree, then verify it renders on /docs via the plugin's velite pipeline. This is the first real content authored against the new system and the proof the pipeline works for humans writing docs, not just compiling existing ones.

Content to cover: what the plugin is and why (docs-as-code over the repo's existing markdown culture), how content is compiled at build time, the frontmatter schema (title, description, tags, order), how to add a doc, and how agents read the docs via OpenAPI/MCP.

Blocked by: #447

Acceptance criteria

  • The plugin's documentation page renders on /docs through the plugin's own pipeline
  • Content follows repo docs conventions (kebab-case naming, GLOSSARY.md vocabulary)
  • Frontmatter demonstrates the full schema (tags, order) so the index view is exercised
Ngôn ngữ chính
TypeScript
Star
5
Fork
3
Merge trung bình
10 giờ 12 phút
Pull request đã merge (30 ngày)
102

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.