de02535c2e
* workspace dash platform guide * fix (docs): Platform Update Guide * feat (scripts): Add utility script to quickly update Changelogs and versions * chore (sdks): Add Changelog files to SDKs * chore (docs): Fix compatability guide * chore (docs): Code Rabbit and Changelog Dates * chore (docs): Code Rabbit * chore (docs): Code Rabbit * chore (docs): Restructure * chore (docs): Code Rabbit * Code Rabit --------- Co-authored-by: Vineeth Voruganti <13438633+VVoruganti@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| _snippets | ||
| changelog | ||
| images | ||
| logo | ||
| v1 | ||
| v2 | ||
| README.md | ||
| bun.lock | ||
| docs.json | ||
| favicon.svg | ||
| package.json | ||
README.md
Honcho Docs
These docs are built using Next.js via mintlify.
Setting Up Honcho's Docs Locally
- Clone the repository:
git clone git@github.com:plastic-labs/honcho.git
- Navigate into the
docsfolder:
cd honcho/docs/
The docs folder contains the markdown files that make up the documentation. The majority of the files are in the pages directory. Some notable files in this folder include:
- Verify that you have Node.js and npm installed in your system. You can check by running:
node --version
npm --version
-
If not installed, download Node.js and npm from the respective official websites.
-
Once you have Node.js and npm running, proceed to install
pnpm- another package manager that helps to manage project dependencies:
npm install -g pnpm
- Install the project dependencies using pnpm:
pnpm i
- After the successful installation of the project dependencies, start the local server:
pnpm dev
Now, you should be able to view the docs on your local environment by visiting http://localhost:3000. You can explore the different markdown files and make changes as you see fit.