reworkd/AgentGPT

✨ Create a guide on how to update the documentation website

Open

#869 aperta il 27 giu 2023

Vedi su GitHub
 (24 commenti) (0 reazioni) (0 assegnatari)TypeScript (9446 fork)batch import
good first issuehelp wanted

Metriche repository

Star
 (34.594 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

We should update the docs site (https://docs.reworkd.ai/development) with some documentation for how to update the docs site itself. It should cover the following:

  • Intro on what mintlify is and link to it
  • Talk about how to run the site locally
  • Talk about how to update a page or create a new page
  • Talk about exactly what we want documented
  • Talk about how to request for documentation (Make an issue on GitHub!)

Guida contributor

Direzione di ricerca
Indaga la struttura esistente del sito di documentazione, probabilmente presente nella cartella docs/ del repository o in una configurazione mintlify separata. Rivedi la documentazione di mintlify per comprenderne la sintassi e le funzionalità. Interagisci con i commenti sull'issue (ce ne sono 24) per vedere se i maintainer hanno fornito preferenze specifiche o modelli. Quindi crea una nuova pagina di guida seguendo lo stile esistente.
Tech stack
typescript
Dominio
developer experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80