Skip to content

Remove initialValue and edit description of default in ParamField #916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 28, 2025

Conversation

mycho2003
Copy link
Contributor

@mycho2003 mycho2003 commented Jul 15, 2025

Documentation changes

In the ParamField element, we claimed to support an initialValue attribute that pre-fills the API Playground, but this wasn't actually supported (see https://github.com/mintlify/mint/pull/3395). This functionality was added to default, and thus the docs are updated to reflect this. Removed initialValue and edited default.

Should review https://github.com/mintlify/mint/pull/3395 first.

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

Copy link
Contributor

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm when the mint PR ships. Thanks for updating the docs!

also for anyone reviewing this PR or Git history in the future: the quickstart edit is accurate (ref: there is no introduction.mdx file, just https://github.com/mintlify/starter/blob/main/index.mdx )

@mycho2003 mycho2003 merged commit 303c2f8 into main Jul 28, 2025
5 checks passed
@mycho2003 mycho2003 deleted the michael/removeinitialvalue branch July 28, 2025 23:46
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.

2 participants