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

Improve default styling and top-level content layout

Đang mở
#34 2 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
20/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
css, fsharp, html
Lĩnh vực
design, documentation, web-dev

Hướng nghiên cứu

Bắt đầu bằng việc xem xét _template.html mặc định hiện tại và kiểu dáng được FSharp.Formatting sử dụng, sau đó so sánh các mối quan tâm được liệt kê về bố cục, tràn, khoảng cách, tên hàm và liên kết logo. Sử dụng phần thảo luận và các ví dụ trực quan được yêu cầu trong issue để xác định các tiêu chí nghiệm thu cụ thể. Được xem là hoàn tất khi các thay đổi về thiết kế và nội dung đã thống nhất được triển khai, đồng thời bố cục của tài liệu được tạo đã được kiểm tra trên các chế độ xem desktop và mobile.

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

Mô tả

As noted by @baronfel in #27, the default styling and top-level layout needs improvement.

What is here is the current default styling for FSharp.Formatting using the standard _template.html, which is tight for iteration but we can do better. If necessary we can add a _template.html or fsdocs-styles.css in here though to be honest I'd love it if we could make the default FSharp.Formatting _template.html good enough to be both configurable for the needs of this repo and to satisfy and please.

Please make a note below everything that you do/don't like about the current design, layout and content. If possible give specific (preferably visual) examples of what you want improved, and, if possible, give links to how those improvements might be made in terms of CSS improvements and JS framework changes.

The things I've noticed so far:

  • The scrollbar on the left appears even if its not needed. This is I believe because of horizontal overflow.

  • Agreed with @baronfel the basic look is very sparse (though I quite enjoyed browsing it on my phone earlier). Also this is tricky as the site is not like most other doc sites as it is only doing FSHarp.Core API docs and is not a general tech doc site.

  • The repetition of parameter XML doc with parameter types is a bit painful (this is an F#F issue)

  • There is a glitch iwhere function names and parameters run together for active patterns and some module functions

  • Agreed with @cartermp that the link on the logo should go to https://fsharp.org

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
37
Fork
20
Merge trung bình
5 phút
Pull request đã merge (30 ngày)
2

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 fsharp/fsharp-core-docs

Tất cả issue của fsharp/fsharp-core-docs

Issue tương tự

Thêm issue về Design

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.