Skip to content

Commit 1be8db4

Browse files
added changelog + added a migration guide
1 parent e3b10e1 commit 1be8db4

File tree

3 files changed

+78
-1
lines changed

3 files changed

+78
-1
lines changed

changelog/overview.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,16 @@ You can now customize the prompts for the AI chat. Please reach out to [support]
6767

6868
## Dashboard Improvements
6969

70+
- Added ability to change custom domain to be /docs directly through dashboard settings.
7071
- Consolidated the login and signup pages to decrease friction and confusion.
7172
- Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.
7273
- Added login with Google OAuth
74+
- Added ability to add new deployment through dashboard settings.
7375

7476
## Bug Fixes
7577

78+
- Can now use leading slashes in navigation.
79+
- Edit CSS & JS files in the web editor.
7680
- Fixed `suggestEdit` not showing up even when enabled.
7781
- Fixed keyboard navigation for Search and Chat such that you can now use the up and down arrow keys to navigate the results.
7882
- Don't allow search engines to crawl user-auth protected pages.

migration.mdx

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: 'Migration'
3+
description: 'How to migrate documentation from your existing provider'
4+
icon: 'arrow-up-from-bracket'
5+
---
6+
7+
You can use our [public packages](https://www.npmjs.com/package/@mintlify/scraping) to scrape documentation frameworks to Mintlify.
8+
9+
We currently support migration for:
10+
- Docusaurus
11+
- GitBook
12+
- ReadMe
13+
14+
If you require more migration assistance, please get in touch at [email protected].
15+
16+
## Commands
17+
18+
- `mintlify-scrape section [url]` - Scrapes multiple pages in a site.
19+
- `mintlify-scrape page [url]` - Scrapes a single page in a site.
20+
21+
22+
The commands will automatically detect the framework.
23+
24+
## 🚀 Installation
25+
26+
First, install the package:
27+
28+
```
29+
npm i @mintlify/scraping
30+
```
31+
32+
One-time use:
33+
<CodeGroup>
34+
```
35+
npx @mintlify/scraping@latest section [url]
36+
```
37+
38+
```
39+
npx @mintlify/scraping@latest page [url]
40+
```
41+
</CodeGroup>
42+
43+
Global installation:
44+
45+
```
46+
npm install @mintlify/scraping@latest -g
47+
```
48+
49+
Global usage:
50+
51+
<CodeGroup>
52+
```
53+
mintlify-scrape section [url]
54+
```
55+
56+
```
57+
mintlify-scrape page [url]
58+
```
59+
</CodeGroup>
60+
61+
Provide the relative path or URL to the OpenAPI file to generate frontmatter files for each endpoint.
62+
63+
<CodeGroup>
64+
65+
```
66+
mintlify-scrape openapi-file [openApiFilename]
67+
```
68+
```
69+
-w, --writeFiles Whether or not to write the frontmatter files [boolean] [default: true]
70+
-o, --outDir The folder in which to write any created frontmatter files [string]
71+
```
72+
</CodeGroup>

mint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@
6262
"quickstart",
6363
"development",
6464
"settings/global",
65-
"settings/navigation"
65+
"settings/navigation",
66+
"migration"
6667
]
6768
},
6869
{

0 commit comments

Comments
 (0)