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.

贡献者指南