reworkd/AgentGPT

✨ Create a guide on how to update the documentation website

Open

#869 opened on Jun 27, 2023

View on GitHub
 (24 comments) (0 reactions) (0 assignees)TypeScript (34,594 stars) (9,446 forks)batch import
good first issuehelp wanted

Description

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
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic MarkdownGit and GitHubFamiliarity with mintlifyLocal development environment
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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.