reactjs / reactjs/react.dev

Suggestion: Improve the Documentation Experience for Creative Text Tools

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

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

Ngôn ngữ chính
JavaScript
Star
11.8k
Fork
7.9k
Merge trung bình
1 ngày 11 giờ
Pull request đã merge (30 ngày)
11

Mô tả

I wanted to share a small suggestion regarding the overall documentation and user experience. Clear examples and practical use cases can make it much easier for new users to understand how a project works and how its features can be applied in real-world situations.

For example, when documentation includes concise examples, screenshots, and explanations of common workflows, users can understand the available functionality without having to search through multiple pages. This is especially helpful for people who are experimenting with creative projects, typography, memes, and simple visual content.

I recently came across the idea of a free brat generator, which is an example of a simple creative tool where straightforward instructions can help users quickly understand how text, colors, fonts, and backgrounds can be combined to create a particular visual style.

A similar approach in documentation could make feature discovery easier. Short examples showing the expected input and output, along with explanations of why a particular approach is recommended, would be useful for both beginners and experienced developers.

Possible Improvements
Add more practical examples for common use cases.
Include clearer explanations for beginners.
Provide small working examples where appropriate.
Make navigation between related documentation sections easier.
Explain common mistakes and recommended solutions.
Keep examples updated as the project evolves.

I think improvements like these could make the documentation more approachable while also helping users discover useful ways to work with the project. It would be great to hear whether others have encountered similar difficulties or have suggestions for improving the documentation experience.

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

Mở hướng dẫn đóng góp

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.

Hướng nghiên cứu

Issue không nêu file, page hoặc test nào để bắt đầu. Trước tiên, hãy xem xét cấu trúc tài liệu và xác định một workflow cụ thể dành cho người mới bắt đầu hoặc một page cần được cải thiện. Được xem là hoàn tất khi có một thay đổi tài liệu với phạm vi rõ ràng, kèm các ví dụ thực tế, phần giải thích rõ ràng hơn và navigation hoặc hướng dẫn được cập nhật khi phù hợp.

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

Đánh giá

Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

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.