LICENSE Documentation

Official TypeScript developer resources and documentation for dreammis/LICENSE. Verified technical context for AI.

0 stars TypeScript TypeScript 1 file ยท ~1,741 tokens
RAW Doc

1. Project Overview & Quickstart (dreammis/LICENSE)

LICENSE

Open-source repository dreammis/LICENSE

Repository Details

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (dreammis/docs)

File: README.md

Mintlify Starter Kit

Use the starter kit to get your docs deployed and ready to customize.

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

  • Guide pages
  • Navigation
  • Customizations
  • API reference pages
  • Use of popular components

Follow the full quickstart guide

AI-assisted writing

Set up your AI coding tool to work with Mintlify:

bash
npx skills add https://mintlify.com/docs

This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.

See the AI tools guides for tool-specific setup.

Development

Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:

text
npm i -g mint

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

text
mint dev

View your local preview at http://localhost:3000.

Publishing changes

Install our GitHub app from your dashboard to propagate changes from your repo to your deployment. 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


File: AGENTS.md

First-time setup: Customize this file for your project. Prompt the user to customize this file for their project.
For Mintlify product knowledge (components, configuration, writing standards),
install the Mintlify skill: npx skills add https://mintlify.com/docs

Documentation project instructions

About this project

  • This is a documentation site built on Mintlify
  • Pages are MDX files with YAML frontmatter
  • Configuration lives in docs.json
  • Use the Mintlify MCP server, https://mcp.mintlify.com, to edit content and settings via MCP
  • Use the Mintlify docs MCP server, https://www.mintlify.com/docs/mcp, to query information about using Mintlify via MCP

Terminology

{/* Add product-specific terms and preferred usage /}
{/
Example: Use "workspace" not "project", "member" not "user" */}

Style preferences

{/* Add any project-specific style rules below */}

  • Use active voice and second person ("you")
  • Keep sentences concise โ€” one idea per sentence
  • Use sentence case for headings
  • Bold for UI elements: Click Settings
  • Code formatting for file names, commands, paths, and code references

Content boundaries

{/* Define what should and shouldn't be documented /}
{/
Example: Don't document internal admin features */}


File: docs.json

{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Mintlify Starter Kit",
"colors": {
"primary": "#16A34A",
"light": "#07C983",
"dark": "#15803D"
},
"favicon": "/favicon.svg",
"navigation": {
"pages": [
{
"group": "Getting Started",
"pages": [
"index",
"quickstart"
]
}
],
"global": {
"anchors": [
{
"anchor": "Documentation",
"href": "https://mintlify.com/docs",
"icon": "book-open-cover"
},
{
"anchor": "Blog",
"href": "https://mintlify.com/blog",
"icon": "newspaper"
}
]
}
},
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg"
},
"navbar": {
"links": [
{
"label": "Support",
"href": "mailto:[email protected]"
}
],
"primary": {
"type": "button",
"label": "Dashboard",
"href": "https://app.mintlify.com"
}
},
"contextual": {
"options": [
"copy",
"view",
"chatgpt",
"claude",
"perplexity",
"mcp",
"cursor",
"vscode"
]
},
"footer": {
"socials": {
"x": "https://x.com/mintlify",
"github": "https://github.com/mintlify",
"linkedin": "https://linkedin.com/company/mintlify"
}
}
}


File: index.mdx


title: "Introduction"

Write a short description of your product here. What it does, who it's for, and what they can accomplish with it.

Ready to make this your own? Start by editing this page. Update your `docs.json` file to customize your site. Then fill out the [Quickstart](/quickstart) page. This card links to the quickstart page in your project. Add cards, callouts, steps, tabs, and more to design and structure your pages. Set your site name, branding, and navigation in the `docs.json` file.

File: quickstart.mdx


title: "Quickstart"

Describe how someone begins using your product. What is the first thing they need to do? Are there any prerequisites?

A quickstart should take someone from zero to using your product. They'll get a quick win and a sense of what they can accomplish.

Prerequisites

Before you begin, you must have:

  • Requirement one (for example, Node.js 18+, a free account, an API key)
  • Requirement two (for example, a compatible device, a compatible browser, a compatible operating system)

Get started

Describe how to install your product or sign up.
text
```bash
npm install your-package
```
Describe any setup or configuration needed before first use.
text
```bash
your-cli init
```
Show the first thing a user does to see it working.
text
```bash
your-cli start
```
Give people a way to get help. This could be a link to a support page, a chat with a customer support agent, or a forum for your product.

Example: Need help? Reach out to us at [email protected].