Skip to content

Address feedback 2026-04-03#5144

Merged
ethanpalm merged 2 commits intomainfrom
feedback-2026-04-03
Apr 4, 2026
Merged

Address feedback 2026-04-03#5144
ethanpalm merged 2 commits intomainfrom
feedback-2026-04-03

Conversation

@ethanpalm
Copy link
Copy Markdown
Collaborator

@ethanpalm ethanpalm commented Apr 3, 2026

Documentation changes


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Low risk documentation-only updates; the main impact is a small navigation reordering and an updated JSON example that could confuse users if inconsistent with the product expectation.

Overview
Surfaces the installation page under the Get started navigation group in docs.json and removes it from the previous location under content creation.

Updates organize/settings.mdx to change the $ref navigation example from a top-level JSON array to an object with a groups array, aligning the example with the expected referenced-file shape.

Reviewed by Cursor Bugbot for commit ce8344c. Bugbot is set up for automated code reviews on this repo. Configure here.

ethanpalm and others added 2 commits April 3, 2026 16:39
The config/navigation.json example showed a bare array, but navigation
is an object with a groups key. Updated the example to match the actual
schema so users copying it get working configuration.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Searches for "cli" had 22 hits with 0% CTR. The installation page was
buried in Create content between web editor docs and text formatting.
Moving it to Get started makes it findable alongside quickstart.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Apr 3, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 3, 2026, 11:59 PM

@ethanpalm ethanpalm merged commit ac8fbd6 into main Apr 4, 2026
5 checks passed
@ethanpalm ethanpalm deleted the feedback-2026-04-03 branch April 4, 2026 00:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant