JuliaDocs/Documenter.jl

Formulate a FAQ/troubleshooting page in the docs

開放

#2,138 建立於 2023年6月8日

 (0 則留言) (0 個反應) (0 位負責人)Julia (513 個分叉)batch import
Type: Documentationhelp wanted

倉庫指標

星標
 (910 顆星)
PR 合併指標
 (平均合併 16天 9小時) (30 天內合併 3 個 PR)

描述

There are quite a few common pitfalls that come up over and over again. We should really just have a troubleshooting page. Some ideas of what should go there:

  • Docs are generally not deploying?
    • Are things showing up on the gh-pages branch?
    • Is DOCUMENTER_KEY properly set up?
    • Is CI for docs starting at all?
    • Is deploydocs running? If not, what error do you see? If yes, does it show git push to somewhere?
  • master shows up, but not tags?
    • Is TagBot working? Is it using DOCUMENTER_KEY?
    • Can you see the tags in your GHA logs?

Would be good to collect other common errors and issues people run into as well.

貢獻者指南