Skip to content

adammbh/greed-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c141bb3 · Aug 18, 2024

History

18 Commits
Aug 18, 2024
Aug 18, 2024
Aug 12, 2024
Jun 22, 2024
Aug 18, 2024
Jun 22, 2024
Aug 5, 2024
Jun 24, 2024
Aug 5, 2024
Aug 5, 2024
Aug 18, 2024
Jun 22, 2024
Jun 22, 2024
Aug 5, 2024

Repository files navigation

Greed Discovery Cover

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages