From 1be8db40c3411224705ef0c78770e11c385b25bc Mon Sep 17 00:00:00 2001 From: Tiffany Date: Mon, 4 Nov 2024 16:00:43 -0800 Subject: [PATCH 1/5] added changelog + added a migration guide --- changelog/overview.mdx | 4 +++ migration.mdx | 72 ++++++++++++++++++++++++++++++++++++++++++ mint.json | 3 +- 3 files changed, 78 insertions(+), 1 deletion(-) create mode 100644 migration.mdx diff --git a/changelog/overview.mdx b/changelog/overview.mdx index 4dd548518..9adc92dd0 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -67,12 +67,16 @@ You can now customize the prompts for the AI chat. Please reach out to [support] ## 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. - Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them. - Added login with Google OAuth +- Added ability to add new deployment through dashboard settings. ## Bug Fixes +- Can now use leading slashes in navigation. +- Edit CSS & JS files in the web editor. - Fixed `suggestEdit` not showing up even when enabled. - Fixed keyboard navigation for Search and Chat such that you can now use the up and down arrow keys to navigate the results. - Don't allow search engines to crawl user-auth protected pages. diff --git a/migration.mdx b/migration.mdx new file mode 100644 index 000000000..b6ee5a739 --- /dev/null +++ b/migration.mdx @@ -0,0 +1,72 @@ +--- +title: 'Migration' +description: 'How to migrate documentation from your existing provider' +icon: 'arrow-up-from-bracket' +--- + +You can use our [public packages](https://www.npmjs.com/package/@mintlify/scraping) to scrape documentation frameworks to Mintlify. + +We currently support migration for: +- Docusaurus +- GitBook +- ReadMe + +If you require more migration assistance, please get in touch at sales@mintlify.com. + +## Commands + +- `mintlify-scrape section [url]` - Scrapes multiple pages in a site. +- `mintlify-scrape page [url]` - Scrapes a single page in a site. + + +The commands will automatically detect the framework. + +## 🚀 Installation + +First, install the package: + +``` +npm i @mintlify/scraping +``` + +One-time use: + +``` +npx @mintlify/scraping@latest section [url] +``` + +``` +npx @mintlify/scraping@latest page [url] +``` + + +Global installation: + +``` +npm install @mintlify/scraping@latest -g +``` + +Global usage: + + +``` +mintlify-scrape section [url] +``` + +``` +mintlify-scrape page [url] +``` + + +Provide the relative path or URL to the OpenAPI file to generate frontmatter files for each endpoint. + + + +``` +mintlify-scrape openapi-file [openApiFilename] +``` +``` +-w, --writeFiles Whether or not to write the frontmatter files [boolean] [default: true] +-o, --outDir The folder in which to write any created frontmatter files [string] +``` + \ No newline at end of file diff --git a/mint.json b/mint.json index e29b2e79a..313f22379 100644 --- a/mint.json +++ b/mint.json @@ -62,7 +62,8 @@ "quickstart", "development", "settings/global", - "settings/navigation" + "settings/navigation", + "migration" ] }, { From 02ab05cc94d8ff92bbd185d30174735dfc8b16f9 Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Mon, 4 Nov 2024 19:00:07 -0800 Subject: [PATCH 2/5] fix wording for changelog --- changelog/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog/overview.mdx b/changelog/overview.mdx index 9adc92dd0..07cd230e5 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -76,7 +76,7 @@ You can now customize the prompts for the AI chat. Please reach out to [support] ## Bug Fixes - Can now use leading slashes in navigation. -- Edit CSS & JS files in the web editor. +- Can now edit CSS & JS files in the web editor. - Fixed `suggestEdit` not showing up even when enabled. - Fixed keyboard navigation for Search and Chat such that you can now use the up and down arrow keys to navigate the results. - Don't allow search engines to crawl user-auth protected pages. From b357370d30f6e283750d1f052f9e25f3aa4127d9 Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Mon, 4 Nov 2024 20:23:45 -0800 Subject: [PATCH 3/5] fix code blocks --- migration.mdx | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/migration.mdx b/migration.mdx index b6ee5a739..00c66f703 100644 --- a/migration.mdx +++ b/migration.mdx @@ -31,11 +31,11 @@ npm i @mintlify/scraping One-time use: -``` +```bash Section npx @mintlify/scraping@latest section [url] ``` -``` +```bash Page npx @mintlify/scraping@latest page [url] ``` @@ -49,24 +49,21 @@ npm install @mintlify/scraping@latest -g Global usage: -``` +```bash Section mintlify-scrape section [url] ``` -``` +```bash Page mintlify-scrape page [url] ``` Provide the relative path or URL to the OpenAPI file to generate frontmatter files for each endpoint. - -``` +```bash mintlify-scrape openapi-file [openApiFilename] -``` -``` + -w, --writeFiles Whether or not to write the frontmatter files [boolean] [default: true] -o, --outDir The folder in which to write any created frontmatter files [string] -``` - \ No newline at end of file +``` \ No newline at end of file From eae2d7835a70816f3952823702dd8637da288846 Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Mon, 4 Nov 2024 20:39:12 -0800 Subject: [PATCH 4/5] add david's suggested changes --- migration.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/migration.mdx b/migration.mdx index 00c66f703..39902b2ca 100644 --- a/migration.mdx +++ b/migration.mdx @@ -11,7 +11,7 @@ We currently support migration for: - GitBook - ReadMe -If you require more migration assistance, please get in touch at sales@mintlify.com. +Don't see your docs provider or have a home grown system? We can still help! Please get in touch at sales@mintlify.com. ## Commands @@ -61,7 +61,7 @@ mintlify-scrape page [url] Provide the relative path or URL to the OpenAPI file to generate frontmatter files for each endpoint. -```bash +``` mintlify-scrape openapi-file [openApiFilename] -w, --writeFiles Whether or not to write the frontmatter files [boolean] [default: true] From 4eb640bf11a4411c12d231b563fcd97f26b5ae25 Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Mon, 4 Nov 2024 20:48:53 -0800 Subject: [PATCH 5/5] use brand svgs for cards --- migration.mdx | 81 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 78 insertions(+), 3 deletions(-) diff --git a/migration.mdx b/migration.mdx index 39902b2ca..491e89454 100644 --- a/migration.mdx +++ b/migration.mdx @@ -7,9 +7,84 @@ icon: 'arrow-up-from-bracket' You can use our [public packages](https://www.npmjs.com/package/@mintlify/scraping) to scrape documentation frameworks to Mintlify. We currently support migration for: -- Docusaurus -- GitBook -- ReadMe + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +} /> + + +} /> + + +} /> + Don't see your docs provider or have a home grown system? We can still help! Please get in touch at sales@mintlify.com.