Hacktoberfest 2026:維護者為十月標記出來的 issue,仍然開放、適合新手。 瀏覽 Hacktoberfest issue

Go documentation is missing reference links

未關閉
#2,157 0 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
3/5
預估耗時
1-2 天
新手友好度
40/100
Issue 類型
缺陷
描述清晰度
基本清楚
活躍度
停滯
技術堆疊
go
領域
documentation

研究方向

比較 devdocs.io 上的 net/http Client.Do 頁面與連結的 pkg.go.dev 參考文件,以識別缺少的原始碼連結和輸入/輸出連結。接著找出 Go 文件產生的進入點及其相關測試;當產生的 Go 參考標頭能一致地公開預期連結時,即表示完成。

由索引模型根據 Issue 內容生成。

描述

docs/improvement

Documentation style bug: Go documentation missing reference links

Summary

devdocs.io is missing useful links in Go reference documentation that are very handy when working with package API:

  • links to the Go source code implementation for the code
  • links to input/output structures

I'm happy to contribute a fix if this is a bug rather than a deliberate choice.

Actual style

See https://devdocs.io/go/net/http/index#Client.Do and how the header does not have links:

Screenshot 2024-02-18 at 21 03 19

Expected style

Official documentation that has links in the header: https://pkg.go.dev/net/http#Client.Do
Screenshot 2024-02-18 at 21 03 28

主要語言
Ruby
星號
39.5k
分支
2.6k
平均合併
2 天 9 小時
30 天內合併 PR
13

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

freeCodeCamp/devdocs 的其他 Issue

查看 freeCodeCamp/devdocs 的全部 Issue

相似的 Issue

更多 Ruby Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。