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

Refactoring required in `Introduction`

Đang mở
#5 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

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
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
nextjs
Lĩnh vực
api, backend, documentation

Hướng nghiên cứu

Bắt đầu bằng cách xác định nội dung Introduction trong docs/ và xem xét các phần Introduction, #-ai-usage-restriction và #-api-calls hiện có. So sánh nội dung API với repository wstack và xác minh rằng các liên kết cũng như ví dụ mã được đề xuất khớp với backend hiện tại. Công việc được xem là hoàn thành khi phần giới thiệu ngắn gọn, các phần được liên kết tồn tại, hướng dẫn về AI đã được cập nhật và tài liệu API dựa trên Hono chính xác.

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

Mô tả

enhancement

This issue outlines necessary improvements to the repository's documentation structure and content to enhance clarity and maintain consistency with project standards in docs/ a.k.a Introduction

Proposed Changes

1. Streamline Introduction Section

Current State
Introduction is overly verbose and reads like a blog post rather than project documentation.

Requested Change

  • Trim introductory content to be more concise
  • use more images/banners than text
  • Maintain only essential headings with brief descriptions
  • Add direct links to detailed documentation pages
  • Follow the pattern:
    Example Structure
    ## API Usage 
    [Brief 2-3 sentence description]  
    For full documentation: [API Overview](/docs/API/Overview)
    

Acceptance Criteria

  • Introduction trimmed and also is having more banners.
  • All major sections contain documentation links
  • Verify all linked doc pages exist
2. Revise AI Usage Guidance

Current State
#-ai-usage-restriction section sends conflicting messages about AI tool usage.

Requested Change

  • Remove restrictive language about AI usage
  • Add helpful system prompt for AI-assisted development:
    ## AI Assistance Guidance
    For optimal results with AI tools (Cursor, VS Code Copilot, etc.), use this prompt:
    "When working with [Project Name], follow these patterns: [list key patterns]"
    
  • Include examples of AI-friendly configuration

Acceptance Criteria

  • Remove existing restriction section from introduction
  • Add new AI guidance section
  • Verify prompt examples work with common AI tools
  • *Make and Add new system prompt for the project. (will require changes here as well as in the wstack repo); so please open new issues.
3. Update API Documentation

Current State
#-api-calls section contains Next.js implementation details. But we're using HONO.dev

Requested Change

  • Conduct technical review of API documentation in contrast with the wstack repo
  • Update content to reflect current backend implementation
  • Add direct link to backend documentation:
    See backend implementation: [API Services](/docs/API/Services)

Acceptance Criteria

  • Technical review completed
  • Implementation details updated
  • Verify code samples match current codebase
  • Add links to relevant backend docs
Ngôn ngữ chính
TypeScript
Star
0
Fork
3
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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 MambaCodes/wstack-docs

Tất cả issue của MambaCodes/wstack-docs

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.