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

added mentions of sonnet-3.7 #550

Open
wants to merge 2 commits 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
4 changes: 2 additions & 2 deletions advanced/rest-api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The Admin API key is used for the majority of the API. It is used to trigger upd

## Chat API key

The Chat API allows you to embed the AI chat experience grounded in your docs and continually kept up to date into any application of your choosing.
The Chat API allows you to embed the AI chat experience into any application of your choosing. It uses [Sonnet-3.7](https://www.anthropic.com/news/claude-3-7-sonnet) to process your documentation within its context window and generate up-to-date, contextual responses.

Responses include citations so you can point your users to the right places they need to get help.

Expand All @@ -39,4 +39,4 @@ Responses include citations so you can point your users to the right places they
</Note>

Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use
the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
12 changes: 7 additions & 5 deletions changelog/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@

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 @@ -19,21 +17,25 @@
npm i mintlify@latest -g
```

2. In your docs repository, run
1. In your docs repository, run

```
mintlify upgrade
```

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

## 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).

## Sonnet-3.7 support

Sonnet-3.7 powers AI features in Mintlify, such as Chat and Assistant.

## .md support for LLMs

Check warning on line 36 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L36

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.

Check warning on line 38 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L38

Did you really mean 'LLMs'?

## More Themes

Expand Down Expand Up @@ -115,7 +117,7 @@
<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 120 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L120

Did you really mean 'LLMs'?

## Localization

Expand Down Expand Up @@ -191,7 +193,7 @@

* 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 196 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L196

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 @@ -215,7 +217,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 220 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L220

Did you really mean 'autogenerated'?

* Add in-line-style support for icons

Expand Down Expand Up @@ -296,7 +298,7 @@

## File Uploads in API Playground

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

Check warning on line 301 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L301

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

Expand Down Expand Up @@ -332,7 +334,7 @@

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 337 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L337

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

* [Read the blog announcement](https://mintlify.com/blog/widget)
Expand All @@ -359,7 +361,7 @@

* 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 364 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L364

Did you really mean 'searchbar'?

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

Expand All @@ -371,7 +373,7 @@
<Update label="May 2024">
## Okta SSO

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

Check warning on line 376 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L376

Did you really mean 'Okta'?

## Mintlify REST API

Expand All @@ -396,7 +398,7 @@
<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 401 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L401

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

<Update label="February 2024">
Expand All @@ -408,7 +410,7 @@

* 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 413 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L413

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

<Update label="January 2024">
Expand All @@ -421,4 +423,4 @@
* 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>
</Update>