docs(docs): link repository files from /docs now that the repository is public

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

Hướng nghiên cứu

Bắt đầu tại src/components/docs/doc-markdown.tsx:216, sau đó src/lib/docs.ts:290 và assertion tại src/lib/docs.test.ts:210; hiện tại mỗi comment nêu repository private là lý do để render các đường dẫn và tham chiếu issue dưới dạng văn bản thuần. Hãy đọc cả ba vị trí cùng lúc trước và chốt quyết định theo từng trường hợp mà issue yêu cầu, rồi cập nhật code, comment và lý do của test đồng bộ. Chạy src/lib/docs.test.ts và, nếu output được render thay đổi, cập nhật e2e/docs.spec.ts bằng Playwright. Hoàn tất nghĩa là không comment hay test nào viện dẫn quyền riêng tư, và mọi tham chiếu tệp hoặc liên kết tới GitHub hoặc nêu lý do hiện hành.

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

Mô tả

area: docs documentation priority: P3 size: S

Context

The repository went public on 2026-11-15. Three places still rely on it being private, found in the #457 review:

  • src/components/docs/doc-markdown.tsx:216: "The repository is private, so a path is shown, never linked."
  • src/lib/docs.ts:290: a repository file "renders as text, not a link".
  • src/lib/docs.test.ts:210: "publishes no issue references" gives the private repository as its reason.

Plan

  1. Decide per case whether /docs should now link repository files and issues on GitHub, or keep rendering them as text for another reason.
  2. Update the code, the comments, and the tests to match.

Acceptance criteria

  • No comment or test reason says the repository is private.
  • Repository file references in /docs either link to the file on GitHub or say why they do not.
  • Playwright e2e: e2e/docs.spec.ts updated if links change.

Files and areas

src/components/docs/doc-markdown.tsx, src/lib/docs.ts, src/lib/docs.test.ts. Non-goals: the docs content itself.

Model: anthropic/claude-opus-5-5 | Reasoning effort: unknown

Ngôn ngữ chính
TypeScript
Star
1
Fork
1
Merge trung bình
6 giờ 56 phút
Pull request đã merge (30 ngày)
136

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 eddiejaoude/StackDash

Tất cả issue của eddiejaoude/StackDash

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.