JuliaDocs/Documenter.jl

Formulate a FAQ/troubleshooting page in the docs

Open

#2138 aperta il 8 giu 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Julia (513 fork)batch import
Type: Documentationhelp wanted

Metriche repository

Star
 (910 star)
Metriche merge PR
 (Merge medio 16g 9h) (3 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Raccogli le insidie comuni dalle issue e dalle discussioni del repository, quindi organizzale in una pagina di risoluzione dei problemi nella documentazione.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75