From 5bd77497b0f16c81e5faf19ecb2cbd093a255f3f Mon Sep 17 00:00:00 2001 From: Kathryn Isabelle Lawrence Date: Mon, 14 Apr 2025 14:32:37 -0700 Subject: [PATCH 1/4] add hidden pages hidden page --- guides/hidden-pages.mdx | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 guides/hidden-pages.mdx diff --git a/guides/hidden-pages.mdx b/guides/hidden-pages.mdx new file mode 100644 index 000000000..0d14857f8 --- /dev/null +++ b/guides/hidden-pages.mdx @@ -0,0 +1,32 @@ +--- +title: "How to add hidden pages" +description: "Exclude pages from your docs.json" +--- + +Sometimes you may want to write a page and not publish it immediately. + +For content that is not strictly confidential, but isn't ready for prime time, you can add pages to your docs without referencing them in your `docs.json`. This is what is considered a "hidden page". + +As long as the page is not described under any "group", "tab" or other element in the navigation section of your `docs.json`, the only way a user will be able to navigate to the page is if they know or guess the page URL. + + +Some navigation elements like sidebars and tabs may shift or appear empty on hidden pages + + +If you want to take further steps to hide hidden pages' content, make sure to add `noindex: true` to the frontmatter of your page. This should prevent the page from appearing in external search results. On the other hand, if you do want hidden pages indexed for SEO purposes you can add the following setting to your `docs.json`: + +``` +"seo" { + "indexing": all +} +``` + +Learn more about SEO and Sitemaps configuration in the [SEO](https://mintlify.com/docs/settings/seo#sitemaps) docs. + + +Contents of hidden pages will not be hidden from internal docs search, and may appear in AI-generated results + + +If you have certain pages that you only want exposed to specific groups of your own users, you may want to use the selective groups access available through [Personalization](https://mintlify.com/docs/settings/authentication-personalization/personalization#showing-hiding-pages). + +If you have docs that you want under no circumstances exposed to the wider web, you may want to use [Authentication](https://mintlify.com/docs/settings/authentication-personalization/authentication). From 95bde84be11af568ba1167b9197417f81e45c466 Mon Sep 17 00:00:00 2001 From: Kathryn Isabelle Lawrence Date: Tue, 15 Apr 2025 12:50:44 -0700 Subject: [PATCH 2/4] update section on internal search --- guides/hidden-pages.mdx | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/guides/hidden-pages.mdx b/guides/hidden-pages.mdx index 0d14857f8..62f99256a 100644 --- a/guides/hidden-pages.mdx +++ b/guides/hidden-pages.mdx @@ -10,10 +10,10 @@ For content that is not strictly confidential, but isn't ready for prime time, y As long as the page is not described under any "group", "tab" or other element in the navigation section of your `docs.json`, the only way a user will be able to navigate to the page is if they know or guess the page URL. -Some navigation elements like sidebars and tabs may shift or appear empty on hidden pages +Some navigation elements like sidebars, dropdowns, and tabs may shift or appear empty on hidden pages. -If you want to take further steps to hide hidden pages' content, make sure to add `noindex: true` to the frontmatter of your page. This should prevent the page from appearing in external search results. On the other hand, if you do want hidden pages indexed for SEO purposes you can add the following setting to your `docs.json`: +If you want hidden pages to be indexed for SEO purposes and don't mind if their content appears in search results, you can add the following setting to your `docs.json`: ``` "seo" { @@ -21,11 +21,10 @@ If you want to take further steps to hide hidden pages' content, make sure to ad } ``` +The settings for SEO indexing also influence whether the contents of hidden pages can appear when your docs are searched internally with the search bar. If you want to make sure hidden pages' content does not appear in SEO or internal search results, make sure to add `noindex: true` to the frontmatter of your page. + Learn more about SEO and Sitemaps configuration in the [SEO](https://mintlify.com/docs/settings/seo#sitemaps) docs. - -Contents of hidden pages will not be hidden from internal docs search, and may appear in AI-generated results - If you have certain pages that you only want exposed to specific groups of your own users, you may want to use the selective groups access available through [Personalization](https://mintlify.com/docs/settings/authentication-personalization/personalization#showing-hiding-pages). From 949cab1909088cd51cfef26353f2c99861675c73 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 20 May 2025 16:48:18 -0700 Subject: [PATCH 3/4] add page to `docs.json` --- docs.json | 1 + 1 file changed, 1 insertion(+) diff --git a/docs.json b/docs.json index 8a4e92352..ef20fc512 100644 --- a/docs.json +++ b/docs.json @@ -137,6 +137,7 @@ "react-components", "settings/custom-scripts", "settings/seo", + "guides/hidden-pages", "settings/broken-links", { "group": "Custom Subdirectory", From ca57ed58592a0c8258895f0d8bd2b0588230b224 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 20 May 2025 17:01:52 -0700 Subject: [PATCH 4/4] Apply suggestions from code review --- guides/hidden-pages.mdx | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/guides/hidden-pages.mdx b/guides/hidden-pages.mdx index 62f99256a..70cf761e8 100644 --- a/guides/hidden-pages.mdx +++ b/guides/hidden-pages.mdx @@ -1,19 +1,18 @@ --- -title: "How to add hidden pages" -description: "Exclude pages from your docs.json" +title: "Hidden pages" +description: "Exclude pages from your `docs.json`" +icon: "eye-closed" --- -Sometimes you may want to write a page and not publish it immediately. +You can use hidden pages for content that is not strictly confidential, but isn't ready for prime time. Hidden pages are excluded from your site's navigation, so people can only access hidden pages if they know the exact URL. -For content that is not strictly confidential, but isn't ready for prime time, you can add pages to your docs without referencing them in your `docs.json`. This is what is considered a "hidden page". - -As long as the page is not described under any "group", "tab" or other element in the navigation section of your `docs.json`, the only way a user will be able to navigate to the page is if they know or guess the page URL. +A page is hidden until you add it to a group, tab, or other navigation element in your `docs.json`. Some navigation elements like sidebars, dropdowns, and tabs may shift or appear empty on hidden pages. -If you want hidden pages to be indexed for SEO purposes and don't mind if their content appears in search results, you can add the following setting to your `docs.json`: +If you want hidden pages to be indexed for SEO purposes and for their contents to appear when people search within your docs, add the following setting to your `docs.json`: ``` "seo" { @@ -21,11 +20,8 @@ If you want hidden pages to be indexed for SEO purposes and don't mind if their } ``` -The settings for SEO indexing also influence whether the contents of hidden pages can appear when your docs are searched internally with the search bar. If you want to make sure hidden pages' content does not appear in SEO or internal search results, make sure to add `noindex: true` to the frontmatter of your page. - -Learn more about SEO and Sitemaps configuration in the [SEO](https://mintlify.com/docs/settings/seo#sitemaps) docs. - +If you want to exclude a specific hidden page's content from search engine and internal search results, add `noindex: true` to the frontmatter of the page. -If you have certain pages that you only want exposed to specific groups of your own users, you may want to use the selective groups access available through [Personalization](https://mintlify.com/docs/settings/authentication-personalization/personalization#showing-hiding-pages). +If you have pages that you want only specific groups of your own users to have access to, you can use the selective groups access available through [Personalization](/settings/authentication-personalization/personalization#showing-hiding-pages). -If you have docs that you want under no circumstances exposed to the wider web, you may want to use [Authentication](https://mintlify.com/docs/settings/authentication-personalization/authentication). +If you have pages that you want to maintain strict access control to, you can use [Authentication](/settings/authentication-personalization/authentication).