83f67822a8
* feat(docs): Initial draft of new contributing policies * feat(ci): defer issue-gate closes to a scheduled sweeper Addresses review feedback on #1041. The gate now reads GitHub's resolved closing references (closingIssuesReferences) instead of regex-parsing the pull request body, so an issue linked through the sidebar Development panel counts, and a bare `#123` mention no longer does. It also no longer closes on the pull request event. It labels and explains; pr-sweeper.yml re-checks every six hours and closes only what is still failing 72 hours after the notice. That re-check is load-bearing: linking an issue via the sidebar fires no webhook, so an event-only gate could never observe a contributor complying that way. The sweeper also closes drafts from outside the org after 30 days. The shared check lives in .github/scripts/issue-gate.js so both workflows run identical logic, with a dependency-free self-check wired into static analysis. Its one regression guard: author_association CONTRIBUTOR stays gated, since GitHub assigns it to anyone who has previously committed. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * chore(codeowners): drop the third reviewer from most areas Discussed with @akattelu. Also reassigns SECURITY.md to @Rajat-Ahuja1997 and strips trailing whitespace from the deployment block. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * docs(v2): port the issue gate policy into the v2 contributing guide The v2 guide is still published (v2.5.1 in docs.json) but carried no mention of the issue gate, so a contributor reading it would not learn that a pull request needs an approved issue until the bot labelled theirs. Ports the policy, both linking routes, and the gate's place among the automated checks, keeping the v2 guide's own structure and unwrapped prose rather than importing the v3 rewrite wholesale. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| changelog | ||
| images | ||
| logo | ||
| snippets | ||
| v1 | ||
| v2 | ||
| v3 | ||
| 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.