Add links to generated documentation in README

Đang mở
  • Có gì không ổn?
#343 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

@nora-soderlund đang làm issue này rồi.

Từ ngày 19/2/2023.

  • #447 của @nora-soderlund — đang mở

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
52/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ệ
openapi, postman
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu trong phần “Description” của README và kiểm tra bảng API cùng với các trang tài liệu của Google Maps Platform. Thêm các liên kết đến tài liệu đã render cho những API tương ứng, sau đó xác minh rằng mọi liên kết trong bảng đều mở đúng trang dự kiến và định dạng của README vẫn rõ ràng.

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

Mô tả

triage me type: feature request

The README for this repo lists the APIs and provides a link to Postman, but if I would like to browse rendered documentation it would be helpful to know where I can see the rendered docs.

Perhaps adding a column to the table in https://github.com/googlemaps/openapi-specification/blob/main/README.md#description with links to the corresponding pages in https://developers.google.com/maps/documentation/ would be the most straightforward way to do this.

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
118
Fork
94
Không có pull request nào được merge trong 30 ngày

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 googlemaps/openapi-specification

Tất cả issue của googlemaps/openapi-specification

Issue tương tự

Thêm issue về Documentation

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.