Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 26 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,42 @@
# Mintlify Starter Kit
# Gigabrain Docs

Use the starter kit to get your docs deployed and ready to customize.
Documentation for [Gigabrain](https://gigabrain.gg) — an AI-powered market intelligence platform for crypto.

Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with
Built with [Mintlify](https://mintlify.com).

- Guide pages
- Navigation
- Customizations
- API reference pages
- Use of popular components
## Local Development

**[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**
1. Install the Mintlify CLI:

## Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:

```
```bash
npm i -g mint
```

Run the following command at the root of your documentation, where your `docs.json` is located:
2. Run the docs locally:

```
```bash
mint dev
```

View your local preview at `http://localhost:3000`.
3. Open `http://localhost:3000` to preview.

## Publishing changes
## Project Structure

Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

## Need help?

### Troubleshooting
```
├── index.mdx # Homepage
├── quickstart.mdx # User onboarding
├── pricing.mdx # Subscription tiers
├── core-features/ # Chat, Alpha, Agents
├── guides/ # Setup guides (agents, integrations, token)
├── developers/ # REST API overview
├── api-reference/ # API endpoint reference
├── ai-tools/ # Cursor, Claude Code, Windsurf setup
├── support/ # FAQs, contact, risk disclosure
├── legal/ # Terms and privacy policy
├── docs.json # Navigation and site config
└── style.css # Custom styling
```

- 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`.
## Publishing

### Resources
- [Mintlify documentation](https://mintlify.com/docs)
Push to the default branch. The Mintlify GitHub app deploys automatically.
4 changes: 0 additions & 4 deletions api-reference/endpoint/create.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions api-reference/endpoint/delete.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions api-reference/endpoint/get.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions api-reference/endpoint/webhook.mdx

This file was deleted.

33 changes: 0 additions & 33 deletions api-reference/introduction.mdx

This file was deleted.

217 changes: 0 additions & 217 deletions api-reference/openapi.json

This file was deleted.

Loading