diff --git a/.gitignore b/.gitignore index 7ac6e62..dd76036 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,6 @@ # IDEs .idea/ .vscode/ + +# Dependencies +node_modules/ diff --git a/docs/CLAUDE.md b/docs/CLAUDE.md index cde9068..49d59e9 100644 --- a/docs/CLAUDE.md +++ b/docs/CLAUDE.md @@ -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` diff --git a/docs/README.md b/docs/README.md index 92b6d8e..8c0b44b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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) diff --git a/package.json b/package.json new file mode 100644 index 0000000..2fb658f --- /dev/null +++ b/package.json @@ -0,0 +1,7 @@ +{ + "name": "agentskills", + "private": true, + "scripts": { + "dev": "cd docs && npx mint dev" + } +}