Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.73 KB

README.md

File metadata and controls

29 lines (18 loc) · 1.73 KB
Greed Discovery Cover

👋 The official repostiry for greed documentation

Over here, you can see the code for the live documentation page which uses the mintlify/starter kit to power and enhance it

⚙️ Getting Started

Requirements

Node.js 20.11.0: JavaScript runtime used to run Javascript code
pnpm 8.14.3: Fast, disk space efficient package manager

Starting the docs locally

  • You must install all the packages by running pnpm i (NOTE: this project uses global packages, which requires you to run pnpm setup if you have not done so yet.)
  • Run mintlify dev to first setup the project, after first start up the docs will start up faster. (for more information, head over to mintlify.com)

📓 Contributing

  • Use conventional commits for your commits to be understood better by other developers. reference
  • Create a pull request and edit your changes then request for the pull change to be approved onto main, make sure to write meaningful descriptions & titles of the change that you have done.
  • Do not use any formatting tools unless you know what you're doing.

😕 Issues

  • If you believe there is an issue, you can pull request and edit by following the steps in "📓 Contributing" or by opening a issue
    • When opening an issue, please ensure that you are using good practices