From 2025e8303d5dedbb199e6ca6afac0b7806be22e6 Mon Sep 17 00:00:00 2001 From: Bryan Helmkamp Date: Mon, 9 Mar 2026 14:05:18 -0400 Subject: [PATCH] docs file cleanup --- docs/AGENTS.md | 33 -------------------------- docs/CONTRIBUTING.md | 34 --------------------------- docs/LICENSE | 21 ----------------- docs/README.md | 55 -------------------------------------------- 4 files changed, 143 deletions(-) delete mode 100644 docs/AGENTS.md delete mode 100644 docs/CONTRIBUTING.md delete mode 100644 docs/LICENSE delete mode 100644 docs/README.md diff --git a/docs/AGENTS.md b/docs/AGENTS.md deleted file mode 100644 index cc4737e03..000000000 --- a/docs/AGENTS.md +++ /dev/null @@ -1,33 +0,0 @@ -> **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](https://mintlify.com) -- Pages are MDX files with YAML frontmatter -- Configuration lives in `docs.json` -- Run `mint dev` to preview locally -- Run `mint broken-links` to check links - -## Terminology - - - - -## Style preferences - - - -- 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 - - - diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md deleted file mode 100644 index 8863ee48f..000000000 --- a/docs/CONTRIBUTING.md +++ /dev/null @@ -1,34 +0,0 @@ -> **Customize this file**: Tailor this template to your project by noting specific contribution types you're looking for, adding a Code of Conduct, or adjusting the writing guidelines to match your style. - -# Contribute to the documentation - -Thank you for your interest in contributing to our documentation! This guide will help you get started. - -## How to contribute - -### Option 1: Edit directly on GitHub - -1. Navigate to the page you want to edit -2. Click the "Edit this file" button (the pencil icon) -3. Make your changes and submit a pull request - -### Option 2: Local development - -1. Fork and clone this repository -2. Install the Mintlify CLI: `npm i -g mint` -3. Create a branch for your changes -4. Make changes -5. Navigate to the docs directory and run `mint dev` -6. Preview your changes at `http://localhost:3000` -7. Commit your changes and submit a pull request - -For more details on local development, see our [development guide](development.mdx). - -## Writing guidelines - -- **Use active voice**: "Run the command" not "The command should be run" -- **Address the reader directly**: Use "you" instead of "the user" -- **Keep sentences concise**: Aim for one idea per sentence -- **Lead with the goal**: Start instructions with what the user wants to accomplish -- **Use consistent terminology**: Don't alternate between synonyms for the same concept -- **Include examples**: Show, don't just tell diff --git a/docs/LICENSE b/docs/LICENSE deleted file mode 100644 index 541137427..000000000 --- a/docs/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2023 Mintlify - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 4552fbc89..000000000 --- a/docs/README.md +++ /dev/null @@ -1,55 +0,0 @@ -# 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](https://starter.mintlify.com/quickstart)** - -## 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](/ai-tools) for tool-specific setup. - -## Development - -Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command: - -``` -npm i -g mint -``` - -Run the following command at the root of your documentation, where your `docs.json` is located: - -``` -mint dev -``` - -View your local preview at `http://localhost:3000`. - -## Publishing changes - -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 - -- 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)