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 (9.446 Forks)batch import
good first issuehelp wanted

Repository-Metriken

Stars
 (34.594 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

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

Research-Richtung
Untersuche die bestehende Dokumentationsseitenstruktur, die sich wahrscheinlich im docs/ Ordner des Repositorys oder in einer separaten mintlify Konfiguration befindet. Überprüfe die mintlify Dokumentation, um deren Syntax und Funktionen zu verstehen. Sieh dir die Kommentare zum Issue an (es gibt 24), um zu prüfen, ob die Maintainer spezifische Präferenzen oder Vorlagen bereitgestellt haben. Erstelle dann eine neue Anleitungsseite gemäß dem vorhandenen Stil.
Tech Stack
typescript
Domain
developer experience
Issue Type
Dokumentation
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 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80