326ea24955
* new layout boilerplate * feat: new sdk documentation * feat: features documentation * fix (docs): Update API Reference * chore (mintlify): Upgrade mintlify * fix (docs): titles * feat: glossary of terms * feat (docs): Add Contextual Menu * chore: clean up architecture.mdx * chore: remove old/unused files, clean up architecture/intro * fix: use `id` over `name` in curl requests * chore: nits on faq * chore: refactor mermaid * feat: quickstart * chore: quickstart doc casing + info about dialectic response * chore: update discord spellbook * chore: update streaming-response, dialectic-endpoint, remove old simple-memory * chore: ts everywhere, update guided tutorial * add get context, search spellbooks * chore: rm faq page * fix contribution page * feat: platform overview and screen grabs * add get context to features * chore: fix self-hosting page * chore: move deriver description into architecture, flesh it out, stub out dialectic architecture * add versioning to docs * quickstart reformat and links * fix v1 api reference * chore: rm deriver from docs sidebar * chore: fix internal links * add sdk changelog and update latest release to 2.0.0 for api changelog * glossary updates and icons * ♻️ Feat: layout for architecture page feat: layout reformat for architecture page * fix changelog * ✨ Feat: vibe coder one-shot prompts feat: vibe coder one-shot prompts * chore: align get context text to spellbook * condense changelog pages * feat: add working-rep spellbook * chore: rename Changelog group * chore: Code Rabbit Suggestions * fix (docs): Update Changelog and API Reference Introduction * fix: remove accordion from glossary * feat: document new filtering system * feat: add telegram bot guide (using new template repo) * checkpoint * Docs MVP * chore (docs): Code Rabbit * Reorganization --------- Co-authored-by: Erosika <eri@plasticlabs.ai> Co-authored-by: Benjamin McCormick <docterformer@protonmail.com> Co-authored-by: Rajat Ahuja <rahuja445@gmail.com> |
||
|---|---|---|
| .. | ||
| _snippets | ||
| changelog | ||
| images | ||
| logo | ||
| v1 | ||
| v2 | ||
| README.md | ||
| docs.json | ||
| favicon.svg | ||
| package.json | ||
| pnpm-lock.yaml | ||
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.