https://github.com/doofinder/docs
https://github.com/doofinder/docs
Last synced: 15 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/doofinder/docs
- Owner: doofinder
- License: mit
- Created: 2026-06-19T14:12:08.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2026-06-29T10:06:41.000Z (28 days ago)
- Last Synced: 2026-06-29T10:11:12.328Z (28 days ago)
- Language: MDX
- Size: 153 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Doofinder API Reference Docs
Source for the Doofinder developer documentation site — Search API, Management API, Stats API, Recommendations API, and Category Merchandising API.
## Local development
Install the [Mintlify CLI](https://www.npmjs.com/package/mint):
```bash
npm i -g mint
```
Run the preview server from the root of this repo (where `docs.json` lives):
```bash
mint dev
```
Open `http://localhost:3000` in your browser.
## AI-assisted writing
To configure your AI coding tool to understand Mintlify components and conventions:
```bash
npx skills add https://mintlify.com/docs
```
This installs Mintlify's writing skill for Claude Code, Cursor, Windsurf, and similar tools.
## Publishing
Changes merged to the default branch are deployed automatically via the Mintlify GitHub app. Configure it from the [Mintlify dashboard](https://dashboard.mintlify.com/settings/organization/github-app).
## Troubleshooting
- **Preview not starting** — run `mint update` to get the latest CLI version.
- **Page shows 404** — make sure `docs.json` is present in the directory where you run `mint dev`.
- **Links broken after a rename** — update both `docs.json` navigation and any `href` references in MDX files.
## Resources
- [Mintlify documentation](https://mintlify.com/docs)
- [Doofinder Admin Panel](https://admin.doofinder.com)
- [Doofinder Support](https://support.doofinder.com)