reworkd/AgentGPT

✨ Create a guide on how to update the documentation website

Open

#869 geöffnet am 27. Juni 2023

Auf GitHub ansehen
 (24 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (34.594 Stars) (9.446 Forks)batch import
good first issuehelp wanted

Beschreibung

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!)

Contributor Guide

Tech Stack
Keine
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic MarkdownGit and GitHubFamiliarity with mintlifyLocal development environment
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90
Research-Richtung
Investigate the existing documentation site structure, likely found in the repository's docs/ folder or a separate mintlify configuration. Review the mintlify documentation to understand its syntax and capabilities. Engage with the comments on the issue (there are 24) to see if maintainers have provided specific preferences or templates. Then create a new guide page following the existing style.