Skip to content

Commit 918af61

Browse files
motatoesmotatoes
committed
init docs
1 parent 7179f98 commit 918af61

28 files changed

+2077
-0
lines changed

‎taco-docs/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Mintlify
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎taco-docs/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Mintlify Starter Kit
2+
3+
Use the starter kit to get your docs deployed and ready to customize.
4+
5+
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
6+
7+
- Guide pages
8+
- Navigation
9+
- Customizations
10+
- API reference pages
11+
- Use of popular components
12+
13+
**[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**
14+
15+
## Development
16+
17+
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
18+
19+
```
20+
npm i -g mint
21+
```
22+
23+
Run the following command at the root of your documentation, where your `docs.json` is located:
24+
25+
```
26+
mint dev
27+
```
28+
29+
View your local preview at `http://localhost:3000`.
30+
31+
## Publishing changes
32+
33+
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.
34+
35+
## Need help?
36+
37+
### Troubleshooting
38+
39+
- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
40+
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
41+
42+
### Resources
43+
- [Mintlify documentation](https://mintlify.com/docs)

‎taco-docs/ai-tools/claude-code.mdx‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: "Claude Code setup"
3+
description: "Configure Claude Code for your documentation workflow"
4+
icon: "asterisk"
5+
---
6+
7+
Claude Code is Anthropic's official CLI tool. This guide will help you set up Claude Code to help you write and maintain your documentation.
8+
9+
## Prerequisites
10+
11+
- Active Claude subscription (Pro, Max, or API access)
12+
13+
## Setup
14+
15+
1. Install Claude Code globally:
16+
17+
```bash
18+
npm install -g @anthropic-ai/claude-code
19+
```
20+
21+
2. Navigate to your docs directory.
22+
3. (Optional) Add the `CLAUDE.md` file below to your project.
23+
4. Run `claude` to start.
24+
25+
## Create `CLAUDE.md`
26+
27+
Create a `CLAUDE.md` file at the root of your documentation repository to train Claude Code on your specific documentation standards:
28+
29+
````markdown
30+
# Mintlify documentation
31+
32+
## Working relationship
33+
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
34+
- ALWAYS ask for clarification rather than making assumptions
35+
- NEVER lie, guess, or make up information
36+
37+
## Project context
38+
- Format: MDX files with YAML frontmatter
39+
- Config: docs.json for navigation, theme, settings
40+
- Components: Mintlify components
41+
42+
## Content strategy
43+
- Document just enough for user success - not too much, not too little
44+
- Prioritize accuracy and usability of information
45+
- Make content evergreen when possible
46+
- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
47+
- Check existing patterns for consistency
48+
- Start by making the smallest reasonable changes
49+
50+
## Frontmatter requirements for pages
51+
- title: Clear, descriptive page title
52+
- description: Concise summary for SEO/navigation
53+
54+
## Writing standards
55+
- Second-person voice ("you")
56+
- Prerequisites at start of procedural content
57+
- Test all code examples before publishing
58+
- Match style and formatting of existing pages
59+
- Include both basic and advanced use cases
60+
- Language tags on all code blocks
61+
- Alt text on all images
62+
- Relative paths for internal links
63+
64+
## Git workflow
65+
- NEVER use --no-verify when committing
66+
- Ask how to handle uncommitted changes before starting
67+
- Create a new branch when no clear branch exists for changes
68+
- Commit frequently throughout development
69+
- NEVER skip or disable pre-commit hooks
70+
71+
## Do not
72+
- Skip frontmatter on any MDX file
73+
- Use absolute URLs for internal links
74+
- Include untested code examples
75+
- Make assumptions - always ask for clarification
76+
````

0 commit comments

Comments
 (0)