docs: add CONTRIBUTING.md with local setup guide - #175
Conversation
Closes traceloop#66 Adds a CONTRIBUTING.md with local development setup instructions, including a fix for the mint.json vs docs.json CLI mismatch that new contributors are likely hitting.
📝 WalkthroughWalkthroughAdded ChangesContributor documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
46-50: 🎯 Functional Correctness | 🔵 Trivial | 💤 Low valueRecord the migration intent around
mint.jsonanddocs.json.This repo still uses
mint.json, but Mintlify has moved towarddocs.json. Add one line to CONTRIBUTING.md / README.md stating whethermint.jsonremains the authoritative manifest here, or that the next migration generatesdocs.json.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@CONTRIBUTING.md` around lines 46 - 50, Add a concise migration note near the troubleshooting entry mentioning mint.json, explicitly state whether mint.json remains the authoritative manifest or whether the next migration will generate docs.json, and keep the existing troubleshooting guidance unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 20-25: Update the step 2 heading in CONTRIBUTING.md from “Install
Mintlify CLI and run the dev server” to “Run the Mintlify dev server” so it
matches the documented npx command and no-install requirement.
- Around line 13-18: Add an explicit instruction in the “Fork and clone the
repo” section telling contributors to replace YOUR_USERNAME in the git clone
command with their GitHub username before executing it.
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 46-50: Add a concise migration note near the troubleshooting entry
mentioning mint.json, explicitly state whether mint.json remains the
authoritative manifest or whether the next migration will generate docs.json,
and keep the existing troubleshooting guidance unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| 1. **Fork and clone the repo** | ||
|
|
||
| ```bash | ||
| git clone https://github.com/YOUR_USERNAME/docs.git | ||
| cd docs | ||
| ``` |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Make the clone command executable for contributors.
YOUR_USERNAME is a placeholder. The guide does not tell contributors to replace it before running the command. Add an explicit instruction.
Proposed fix
1. **Fork and clone the repo**
+ Replace `YOUR_USERNAME` with your GitHub username:
+
```bash
git clone https://github.com/YOUR_USERNAME/docs.git📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. **Fork and clone the repo** | |
| ```bash | |
| git clone https://github.com/YOUR_USERNAME/docs.git | |
| cd docs | |
| ``` | |
| 1. **Fork and clone the repo** | |
| Replace `YOUR_USERNAME` with your GitHub username: | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` around lines 13 - 18, Add an explicit instruction in the
“Fork and clone the repo” section telling contributors to replace YOUR_USERNAME
in the git clone command with their GitHub username before executing it.
| 2. **Install Mintlify CLI and run the dev server** | ||
|
|
||
| This repo is powered by [Mintlify](https://mintlify.com). No separate install step is needed — just run: | ||
|
|
||
| ```bash | ||
| npx mintlify@latest dev |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Align the step heading with the documented action.
The heading says “Install Mintlify CLI,” but the text says that no separate installation is needed. Rename the heading to “Run the Mintlify dev server” to remove this contradiction.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` around lines 20 - 25, Update the step 2 heading in
CONTRIBUTING.md from “Install Mintlify CLI and run the dev server” to “Run the
Mintlify dev server” so it matches the documented npx command and no-install
requirement.
1 participant
Closes #66
Adds a CONTRIBUTING.md with local development setup instructions, including a fix for the mint.json vs docs.json CLI mismatch that new contributors are likely hitting.
Summary by CodeRabbit