DiamondLightSource / DiamondLightSource/python-copier-template

Standardisation of sphinx docs page titles

Đang mở
#232 14 bình luận 0 reaction 0 người được giao Xem trên GitHub
enhancement
Ngôn ngữ chính
Jinja
Star
25
Fork
10
Merge trung bình
4 giờ 4 phút
Pull request đã merge (30 ngày)
6

Mô tả

This may be the nitpickiest issue I have ever raised, so should not be actioned unless there's strong agreement.

![Image](https://github.com/user-attachments/assets/a1729ee3-5e8e-4789-b686-dca7b6d64ba0)
(from https://diamondlightsource.github.io/python-copier-template/main/how-to.html)

It annoys me that the titles for docs pages are not really standardised, Some Are Capitalised, some are not, some are prefixed with "How to" or similar. If there is a really easy check that can be added to the docs builds it might add a layer of consistency and professionalism. The hardest part, as ever when we talk about formatting, may be agreeing on which standard to use.

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

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

Hướng nghiên cứu

Review the example page at https://diamondlightsource.github.io/python-copier-template/main/how-to.html and the issue discussion first, since no source file or test is named. Confirm that the project has agreed on a title convention and identify the docs build entry point before scoping a check; done means the convention is explicit and the build consistently enforces it.

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
build-system, 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
Đình trệ
Độ 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.