Skip to content
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

Fix sentence casing in Changelog headlines #542

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 34 additions & 36 deletions changelog/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@
---

<Update label="February 2025">
## New Configuration Schema `docs.json`
## New configuration schema `docs.json`

We've introduced a new `docs.json` schema as a replacement for `mint.json`, to support better multi-level versioning, easier visual comprehension, and more consistent terminology. For more information on what's changed, [check out our blog](https://mintlify.com/blog/refactoring-mint-json-into-docs-json).&#x20;



Upgrade from `mint.json` to `docs.json` with the following steps:

1. Make sure your CLI is the latest version
Expand All @@ -27,15 +25,15 @@

3. Delete your old mint.json file and push your changes

## CI Checks
## CI checks

Automatically lint your docs to find broken links, discover spelling and grammar issues, or enforce writing styles with your own Vale config. Learn more in our [docs](settings/ci).

## .md support for LLMs

Check warning on line 32 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L32

Did you really mean 'LLMs'?

All documentation pages are now automatically available as plain Markdown files—just append `.md` to the URL. This makes it easier for LLMs to ingest individual pages from your documentation.
All documentation pages are now automatically available as plain Markdown files—just append `.md` to the URL. This makes it easier for LLMs to ingest individual pages from your documentation.

Check warning on line 34 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L34

Did you really mean 'LLMs'?

## More Themes
## More themes

New pre-built themes to modify the look & feel of your docs. Configure via your [docs.json file](/settings/global).

Expand All @@ -47,7 +45,7 @@
</Update>

<Update label="January 2025">
## AI Assistant Improvements
## AI assistant improvements

* New UI with dedicated chat page & pre-filled prompts

Expand All @@ -57,21 +55,21 @@

* Improved mint.json file editing

## Partial Authentication
## Partial authentication

Customize access to any page or section of content depending on user permissions. Supports connecting with your own authentication system.

## Revamped API Playground

Weve overhauled the design and performance of the [API Playground](/api-playground/). Updates include:
We've overhauled the design and performance of the [API Playground](/api-playground/). Updates include:

* Easier detail expansion for an overview of a field

* More intuitive nested design, e.g. adding or deleting items

* Faster response times

## Quality Improvements
## Quality improvements

* Support for requiring authentication to access preview deployments
</Update>
Expand All @@ -95,7 +93,7 @@

You can now ask AI to make changes to your docs, with the context of all existing documentation. Type in a prompt and the assistant will propose changes by generating a pull request.

## GitLab Integration Upgrade
## GitLab integration upgrade

We've improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out our [docs on GitLab](/settings/gitlab) to get started.

Expand All @@ -105,7 +103,7 @@
<img src="/images/changelog/webeditor.jpg" alt="Web Editor" />
</Frame>

We've revamped our web editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown.
We've revamped our Web Editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown.

Check out our [docs on getting started with Web Editor](/web-editor).

Expand All @@ -115,13 +113,13 @@
<img src="/images/changelog/llms.jpg" alt="llms.txt support" />
</Frame>

All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)

Check warning on line 116 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L116

Did you really mean 'LLMs'?

## Localization

You can now localize your docs which operates similarly to versioning. Add a `locale` to a version and fixed content in Mintlify like "Was this page helpful?" will also match the locale.

### Quality Improvements
### Quality improvements

* Return chat & search results based on the current version that the user is reading

Expand All @@ -137,7 +135,7 @@
<img src="/images/changelog/changelog.jpg" alt="Changelog" />
</Frame>

## Code Line Highlighting
## Code line highlighting

You can now highlight lines of code in your docs to emphasize and bring attention to important parts by adding a special comment after the language identifier. Use curly braces `{}` and specify line numbers or ranges separated by commas.

Expand Down Expand Up @@ -169,7 +167,7 @@
}
```

## Advanced Footer
## Advanced footer

<Frame>
<img src="/images/changelog/advanced-footer.gif" alt="Advanced Footer" />
Expand All @@ -183,15 +181,15 @@

When personalization is enabled, search results are now filtered based on the current logged in user so that they only see the relevant content.

## Custom Prompts for AI Chat
## Custom prompts for AI chat

You can now customize the prompts for the AI chat. Please reach out to [support](mailto:[email protected]) if you'd like to customize the prompts.

## Dashboard Improvements
## Dashboard improvements

* Added ability to change custom domain to be /docs directly through dashboard settings.

* Consolidated the login and signup pages to decrease friction and confusion.

Check warning on line 192 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L192

Did you really mean 'signup'?

* Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.

Expand All @@ -199,7 +197,7 @@

* Added ability to add new deployment through dashboard settings.

## Bug Fixes
## Bug fixes

* Can now use leading slashes in navigation.

Expand All @@ -215,7 +213,7 @@

* We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages.

* Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions.

Check warning on line 216 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L216

Did you really mean 'autogenerated'?

* Add in-line-style support for icons

Expand All @@ -227,7 +225,7 @@
</Update>

<Update label="September 2024">
## Custom Fonts
## Custom fonts

<Frame>
<img src="/images/changelog/custom-fonts.jpeg" alt="Custom Fonts" />
Expand All @@ -239,7 +237,7 @@

Add an `img` property to a card to display an image on the top of the card. Learn more about it [here](/content/components/cards#image-card).

## Update Speed Performances
## Update speed performances

<Frame>
<img src="/images/changelog/performance-improvements.png" alt="Performance Improvements" />
Expand All @@ -257,7 +255,7 @@

We've fixed both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements.

## Dashboard Improvements
## Dashboard improvements

* App router migration in the dashboard.

Expand All @@ -271,7 +269,7 @@

* Add-on's can now be directly purchased through the dashboard.

## Bug Fixes
## Bug fixes

* Fixed a bug where the top bar would not stretch to the width of the screen when it's in custom mode and the sidebar layout is `sidenav`.

Expand All @@ -285,7 +283,7 @@
</Update>

<Update label="August 2024">
## OpenAPI Reference Pages
## OpenAPI reference pages

* Endpoints defined by OpenAPI that are complex and recursive are now 98%
smaller.
Expand All @@ -294,9 +292,9 @@
[additionalProperties](https://swagger.io/docs/specification/data-models/dictionaries/)
in OpenAPI pages.

## File Uploads in API Playground
## File uploads in API Playground

By default, API playground requests are proxied by Mintlify. Now you can use

Check warning on line 297 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L297

Did you really mean 'proxied'?
`disableProxy` to disable this behavior and support request types like file
uploads.

Expand All @@ -307,12 +305,12 @@
We've fixed the mobile layout of our docs so that they are more SEO-friendly -
including adding proper aria tags to elements.

## Support Form
## Support form

We added a more detailed support form to the Mintlify dashboard. You can now
submit a form to get in touch with us.

## Bug Fixes
## Bug fixes

* Fixed a bug for the Segment integration functionality.

Expand All @@ -332,18 +330,18 @@

For `Pro` users, we introduced Mintlify Widget, an extension of your docs to
answer your users' questions when and where they asked. You can add this
AI-powered chatbot to any web page: your landing page, inside your product, or

Check warning on line 333 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L333

Did you really mean 'chatbot'?
on your existing documentation pages.

* [Read the blog announcement](https://mintlify.com/blog/widget)

## Pro Plan
## Pro plan

We also updated our pricing plans for better customizability and scale.

* [Read the blog announcement](https://mintlify.com/blog/pro-plan)

## API Playground Code Example Sync
## API Playground code example sync

When you browse API docs, the selected code example now syncs across your pages.

Expand All @@ -355,23 +353,23 @@
</Update>

<Update label="June 2024">
## Launch Week Highlights
## Launch week highlights

* Themes: Customize your styling with pre-configured themes. Just add the theme Quill, Prism, or Venus to your `mint.json` file and it'll update your docs styling.

* Search V2: directly query OpenAPI endpoint descriptions and titles to reach API Reference pages, remove hidden pages from search, and enjoy our updated searchbar UI.

Check warning on line 360 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L360

Did you really mean 'searchbar'?

* Web Editor branching: create branches in our web editor without an IDE.

* User Personalization: authenticate users with Shared Session or JWT so that you can show them customized content, such as pre-filling API keys or showing specific content for customers.
* User personalization: authenticate users with Shared Session or JWT so that you can show them customized content, such as pre-filling API keys or showing specific content for customers.

* OepenAPI Automation Upgrades: to auto-populate API Playground pages, you can add an `openapi` field to an object in tabs or anchors arrays in the mint.json.
* OpenAPI automation upgrades: to auto-populate API Playground pages, you can add an `openapi` field to an object in tabs or anchors arrays in the mint.json.
</Update>

<Update label="May 2024">
## Okta SSO

We now support sign-on via Okta SAML and OIDC.

Check warning on line 372 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L372

Did you really mean 'Okta'?

## Mintlify REST API

Expand All @@ -396,11 +394,11 @@
<Update label="March 2024">
## Mintlify MDX for VSCode

Call snippets of our pre-built components an dcallouts without leaving VSCode. [Install the extension here](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).

Check warning on line 397 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L397

Did you really mean 'dcallouts'?
</Update>

<Update label="February 2024">
## Quality Improvements
## Quality improvements

* Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments

Expand All @@ -408,17 +406,17 @@

* Wildcard redirects now supported

* CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development

Check warning on line 409 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L409

Did you really mean 'frontmatter'?
</Update>

<Update label="January 2024">
## Launch Week Highlights
## Launch week highlights

* Preview Deployments: When you create a pull request, we'll generate a unique link that shows a live preview of what your docs look like in prod. You can share this link with teammates.
* Preview deployments: When you create a pull request, we'll generate a unique link that shows a live preview of what your docs look like in prod. You can share this link with teammates.

* Snippets V2: We now support fully reusable components and variables for snippets.

* Open-source MDX Engine: We've exposed two APIs—getCompiledMdx and MDXComponent—so you can access Mintlify markdown and code syntax highlighting. [Contributions to the project](https://github.com/mintlify/mdx) are welcome.

* AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears.
</Update>
* AI Chat insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears.
</Update>
19 changes: 14 additions & 5 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@
{
"group": "Editing",
"icon": "pen-paintbrush",
"pages": ["development", "web-editor"]
"pages": [
"development",
"web-editor"
]
},
"settings/global",
{
Expand Down Expand Up @@ -133,7 +136,10 @@
{
"group": "Dashboard Access",
"icon": "house-lock",
"pages": ["advanced/dashboard/sso", "advanced/dashboard/permissions"]
"pages": [
"advanced/dashboard/sso",
"advanced/dashboard/permissions"
]
},
{
"group": "REST API",
Expand Down Expand Up @@ -205,7 +211,7 @@
"pages": [
"integrations/analytics/overview",
"integrations/analytics/amplitude",
"integrations/analytics/clearbit",
"integrations/analytics/clearbit",
"integrations/analytics/fathom",
"integrations/analytics/google-analytics",
"integrations/analytics/google-tag-manager",
Expand Down Expand Up @@ -251,7 +257,10 @@
"groups": [
{
"group": "Changelog",
"pages": ["changelog/overview"]
"pages": [
"changelog/overview",
"changelog/overview"
]
}
]
}
Expand Down Expand Up @@ -363,4 +372,4 @@
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
}
}
}
}