Add package.json to docs for local mint dev dependency (#141)

* Add package.json to docs for local mint dev dependency

Allow installing mint as a local dev dependency instead of requiring
a global install, making the setup more reproducible.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Use npx mint dev to avoid mint version bug

Address PR review feedback: the mint package has a bug that causes it
to use the wrong version when installed as an npm dependency. Switch to
npx mint dev, remove the devDependency and package-lock.json, and
simplify docs accordingly.

* Move `package.json` to repo root and clean up docs

Move the `package.json` from `docs/` to the repo root so `npm run dev`
works from anywhere in the repository. Update `CLAUDE.md` instructions
to match, trim boilerplate from `docs/README.md`, and link to the live
documentation site.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Jonathan Hefner <jonathan@hefner.pro>
This commit is contained in:
lilac
2026-02-28 07:47:34 +08:00
committed by GitHub
Unverified
parent 6102affec8
commit fbb6c829fd
4 changed files with 17 additions and 29 deletions
+3
View File
@@ -4,3 +4,6 @@
# IDEs
.idea/
.vscode/
# Dependencies
node_modules/
+3 -9
View File
@@ -4,19 +4,13 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
## Documentation
The Agent Skills documentation site, defined in the `docs/` directory, is built with [Mintlify](https://mintlify.com).
The Agent Skills documentation site, defined in the `docs/` directory, is built with [Mintlify](https://mintlify.com).
### Quick Start Commands
```bash
# Install Mintlify CLI (required for local development)
npm i -g mint
# Run local development server (run from /docs directory)
cd docs && mint dev
# Update Mintlify CLI if dev server issues occur
mint update
# Run local development server
npm run dev
```
Local preview available at `http://localhost:3000`
+4 -20
View File
@@ -1,19 +1,13 @@
# Agent Skills Documentation
This directory contains the source code for the Agent Skills documentation site, which is built using [Mintlify](https://mintlify.com).
This directory contains the source code for the Agent Skills [documentation site](https://agentskills.io/), which is built using [Mintlify](https://mintlify.com).
## Development
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
Run the following command at the documentation root, where `docs.json` is located:
```
npm i -g mint
```
Run the following command at the root of your documentation, where your `docs.json` is located:
```
mint dev
```bash
npx mint dev
```
View your local preview at `http://localhost:3000`.
@@ -21,13 +15,3 @@ View your local preview at `http://localhost:3000`.
## Publishing changes
Changes are deployed to production automatically after pushing to the default branch.
## Need help?
### Troubleshooting
- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
### Resources
- [Mintlify documentation](https://mintlify.com/docs)
+7
View File
@@ -0,0 +1,7 @@
{
"name": "agentskills",
"private": true,
"scripts": {
"dev": "cd docs && npx mint dev"
}
}