docs: rewrite README for Mintlify local dev#10
Draft
samgutentag wants to merge 1 commit into
Draft
Conversation
Replaces the stock Mintlify starter README with Trunk-specific setup instructions: prereqs, clone/install/dev steps, `mint login` for local search, a useful-commands table, publishing flow, and troubleshooting. Removes the broken `/ai-tools` link and stale starter-template copy. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replaces the stock "Mintlify Starter Kit" README with a Trunk-specific local-dev guide.
mint devsteps,mint loginfor local searchmint validate,mint broken-links,mint a11y,mint status,mint version,mint update/ai-toolslink and the stale "Use this template" starter-template copyKnown follow-up
The "Enabling local search" section is intentionally stubbed — needs first-hand details (browser vs. terminal flow, SSO behavior) after running
mint login. Tracked separately.Test plan
npm i -g mint(or confirmmint --versionworks)mint devfrom the repo root — dev server starts, port loggedmint login→ reload → search works🤖 Generated with Claude Code