diff --git a/.vale/styles/FernStyles/Headings.yml b/.vale/styles/FernStyles/Headings.yml index 752158924c..51f8a387f2 100644 --- a/.vale/styles/FernStyles/Headings.yml +++ b/.vale/styles/FernStyles/Headings.yml @@ -100,6 +100,7 @@ exceptions: - Fern Editor - Writer - Fern Writer + - Ask AI - Ask Fern - Explorer - Autorelease diff --git a/AGENTS.md b/AGENTS.md index bc3644e237..e746334352 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -127,7 +127,7 @@ Then read each candidate to find the natural insertion point. Common targets: - **Behavior pages** — e.g., a feature affects search → cross-link from `customization/search.mdx`. - **Dashboard pages** — e.g., a feature has dashboard settings → cross-link from `dashboard/pages/`. -- **Adjacent feature pages** — e.g., Ask Fern, RBAC, localization, when scope or behavior overlaps. +- **Adjacent feature pages** — e.g., Ask AI, RBAC, localization, when scope or behavior overlaps. - **Overview / landing pages** — sometimes a card on a hub page is warranted; usually only when the feature is a top-level setup step, not a configuration detail. ### Pick the form diff --git a/fern/apis/fai/openapi.json b/fern/apis/fai/openapi.json index 94bdf13023..5b87953e42 100644 --- a/fern/apis/fai/openapi.json +++ b/fern/apis/fai/openapi.json @@ -4863,7 +4863,7 @@ "document": { "type": "string", "title": "Document", - "description": "The content of the code document that will be returned to Ask Fern during retrieval." + "description": "The content of the code document that will be returned to Ask AI during retrieval." }, "chunk": { "anyOf": [ @@ -4887,7 +4887,7 @@ } ], "title": "Title", - "description": "The title of the code document. This will be used with the `url` when Ask Fern cites this code." + "description": "The title of the code document. This will be used with the `url` when Ask AI cites this code." }, "url": { "anyOf": [ @@ -4899,7 +4899,7 @@ } ], "title": "Url", - "description": "The url of the code document. This will be used as the source when Ask Fern cites it." + "description": "The url of the code document. This will be used as the source when Ask AI cites it." }, "version": { "anyOf": [ @@ -4911,7 +4911,7 @@ } ], "title": "Version", - "description": "The version of the code. This will be compared against when running Ask Fern with version filters. If null, the code will be retrievable by all versions." + "description": "The version of the code. This will be compared against when running Ask AI with version filters. If null, the code will be retrievable by all versions." }, "product": { "anyOf": [ @@ -4923,7 +4923,7 @@ } ], "title": "Product", - "description": "The product of the code. This will be used to filter code when running Ask Fern with product filters. If null, the code will be retrievable by all products." + "description": "The product of the code. This will be used to filter code when running Ask AI with product filters. If null, the code will be retrievable by all products." }, "keywords": { "anyOf": [ @@ -4979,7 +4979,7 @@ "document": { "type": "string", "title": "Document", - "description": "The content of the document that will be returned to Ask Fern during document retrieval." + "description": "The content of the document that will be returned to Ask AI during document retrieval." }, "chunk": { "anyOf": [ @@ -5003,7 +5003,7 @@ } ], "title": "Title", - "description": "The title of the document. This will be used with the `url` when Ask Fern cites this document." + "description": "The title of the document. This will be used with the `url` when Ask AI cites this document." }, "url": { "anyOf": [ @@ -5015,7 +5015,7 @@ } ], "title": "Url", - "description": "The url of the document. This will be used as the source of the document when Ask Fern cites it." + "description": "The url of the document. This will be used as the source of the document when Ask AI cites it." }, "version": { "anyOf": [ @@ -5027,7 +5027,7 @@ } ], "title": "Version", - "description": "The version of the document. This will be compared against when running Ask Fern with version filters. If null, the document will be retrievable by all versions." + "description": "The version of the document. This will be compared against when running Ask AI with version filters. If null, the document will be retrievable by all versions." }, "product": { "anyOf": [ @@ -5039,7 +5039,7 @@ } ], "title": "Product", - "description": "The product of the document. This will be used to filter documents when running Ask Fern with product filters. If null, the document will be retrievable by all products." + "description": "The product of the document. This will be used to filter documents when running Ask AI with product filters. If null, the document will be retrievable by all products." }, "keywords": { "anyOf": [ @@ -5175,7 +5175,7 @@ "document": { "type": "string", "title": "Document", - "description": "The content of the guidance document that will be returned to Ask Fern during Ask Fern retrieval." + "description": "The content of the guidance document that will be returned to Ask AI during Ask AI retrieval." } }, "type": "object", @@ -7229,7 +7229,7 @@ } ], "title": "Document", - "description": "The updated content of the document that will be returned to Ask Fern during document retrieval. If not provided, this field will remain unchanged." + "description": "The updated content of the document that will be returned to Ask AI during document retrieval. If not provided, this field will remain unchanged." }, "chunk": { "anyOf": [ @@ -7362,7 +7362,7 @@ } ], "title": "Document", - "description": "The updated content of the guidance document that will be returned to Ask Fern during Ask Fern retrieval. If not provided, this field will remain unchanged." + "description": "The updated content of the guidance document that will be returned to Ask AI during Ask AI retrieval. If not provided, this field will remain unchanged." } }, "type": "object", diff --git a/fern/assets/styles.css b/fern/assets/styles.css index 7f7c9bbbc4..26f5b51e45 100644 --- a/fern/assets/styles.css +++ b/fern/assets/styles.css @@ -1084,6 +1084,25 @@ h1, h2, h3 { display: inline-block; } +.cli-graphic-container { + width: 100%; + display: block; + position: relative; + overflow: hidden; + border-radius: 12px; +} + +.cli-graphic-container.fade-bottom { + mask: linear-gradient(to bottom, rgba(0,0,0,1) 70%, rgba(0,0,0,0) 100%); + -webkit-mask: linear-gradient(to bottom, rgba(0,0,0,1) 70%, rgba(0,0,0,0) 100%); +} + +.cli-graphic-container img { + width: 100%; + height: auto; + display: block; +} + /*** END -- LANDING PAGE STYLING ***/ /* HACK: add a slash to markdown snippet documentation (otherwise it gets parsed by CLI) */ diff --git a/fern/components/FernFooter.tsx b/fern/components/FernFooter.tsx index 70ab499471..d7ee29d892 100644 --- a/fern/components/FernFooter.tsx +++ b/fern/components/FernFooter.tsx @@ -440,7 +440,7 @@ export default function FernFooter() {
diff --git a/fern/docs.yml b/fern/docs.yml index 1ad76ba12b..dc64a98158 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -749,74 +749,76 @@ redirects: destination: /learn/cli-api-reference/cli-reference/overview # ============================================================================ - # ASK FERN (AI SEARCH) + # ASK AI (AI SEARCH) # ============================================================================ # /learn/ask-fern/api-reference (specifics before catchall — were shadowed) - source: /learn/ask-fern/api-reference/conversations/get-conversation - destination: /learn/docs/ai-features/ask-fern/api-reference/overview + destination: /learn/docs/ai-features/ask-ai/api-reference/overview - source: /learn/ask-fern/api-reference/queries/:slug* - destination: /learn/docs/ai-features/ask-fern/api-reference/overview + destination: /learn/docs/ai-features/ask-ai/api-reference/overview - source: /learn/ask-fern/api-reference/overview - destination: /learn/docs/ai-features/ask-fern/api-reference/overview + destination: /learn/docs/ai-features/ask-ai/api-reference/overview - source: /learn/ask-fern/api-reference/:slug* - destination: /learn/docs/ai-features/ask-fern/api-reference/:slug* + destination: /learn/docs/ai-features/ask-ai/api-reference/:slug* # /learn/ask-fern/features (specifics before catchall — custom-fa-qs was shadowed) - source: /learn/ask-fern/features/custom-fa-qs - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/features/analytics - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/features/citations - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/features/insights - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/features/evaluation - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/features/rbac - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/features/slack-app - destination: /learn/docs/ai-features/ask-fern/slack-app + destination: /learn/docs/ai-features/ask-ai/slack-app - source: /learn/ask-fern/features/scribe-slack-app destination: /learn/docs/ai-features/fern-writer # /learn/ask-fern/* other specifics - source: /learn/ask-fern/getting-started/what-is-ask-fern - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/getting-started/how-it-works - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/configuration/setup - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/configuration/guidance - destination: /learn/docs/ai-features/ask-fern/guidance + destination: /learn/docs/ai-features/ask-ai/guidance - source: /learn/ask-fern/configuration/content-sources - destination: /learn/docs/ai-features/ask-fern/content-sources + destination: /learn/docs/ai-features/ask-ai/content-sources - source: /learn/ask-fern/configuration/documents - destination: /learn/docs/ai-features/ask-fern/content-sources + destination: /learn/docs/ai-features/ask-ai/content-sources - source: /learn/ask-fern/configuration/locations-and-datasources - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/configuration/custom-prompts - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/overview - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/citations - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/custom-prompting - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ask-fern/customer-showcase destination: https://buildwithfern.com/customers - source: /learn/ask-fern/:slug* - destination: /learn/docs/ai-features/ask-fern/:slug* + destination: /learn/docs/ai-features/ask-ai/:slug* - # Ask Fern new-location cleanup (/learn/docs/ai-features/ask-fern/*) + # Ask AI new-location cleanup (/learn/docs/ai-features/ask-fern/*) - source: /learn/docs/ai-features/ask-fern/how-it-works - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/docs/ai-features/ask-fern/features - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/docs/ai-features/ask-fern/setup - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/docs/ai-features/ask-fern/discord-bot - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview + - source: /learn/docs/ai-features/ask-fern/:slug* + destination: /learn/docs/ai-features/ask-ai/:slug* # /learn/ai-search/* (legacy) — specifics before catchall - source: /learn/ai-search/getting-started/ai-search-customer-showcase @@ -824,17 +826,17 @@ redirects: - source: /learn/ai-search/customer-showcase destination: https://buildwithfern.com/customers - source: /learn/ai-search/overview - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ai-search/custom-prompting - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ai-search/citations - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ai-search/features/:slug* - destination: /learn/docs/ai-features/ask-fern/overview + destination: /learn/docs/ai-features/ask-ai/overview - source: /learn/ai-search/getting-started/:slug* - destination: /learn/docs/ai-features/ask-fern/:slug* + destination: /learn/docs/ai-features/ask-ai/:slug* - source: /learn/ai-search/:slug* - destination: /learn/docs/ai-features/ask-fern/:slug* + destination: /learn/docs/ai-features/ask-ai/:slug* # ============================================================================ # MISC LEGACY diff --git a/fern/footer-dist/output.js b/fern/footer-dist/output.js index 232c17be27..933d60f0f9 100644 --- a/fern/footer-dist/output.js +++ b/fern/footer-dist/output.js @@ -339,4 +339,4 @@ Error generating stack: `+o.message+` min-width: 200px; } } - `}),d.jsxs("footer",{className:"footer",children:[d.jsxs("div",{className:"footer-top",children:[d.jsxs("a",{className:"footer-logo",href:"https://buildwithfern.com",children:[d.jsx(N2,{className:"footer-logo-img dark:hidden"}),d.jsx(T2,{className:"footer-logo-img hidden dark:block"})]}),d.jsxs("div",{className:"footer-status",children:[d.jsx(k2,{}),d.jsxs("a",{className:"soc2-badge",href:"https://security.buildwithfern.com/",children:[d.jsx(E2,{className:"soc2-badge-img"}),d.jsx("span",{className:"status-text",children:"Soc 2 Type II"})]})]})]}),d.jsxs("div",{className:"footer-links",children:[d.jsx("div",{className:"footer-bottom-text",children:" © 2026 Fern • Birch Solutions, Inc., a Postman company"}),d.jsxs("div",{className:"footer-columns",children:[d.jsxs("div",{className:"footer-column",children:[d.jsx("h4",{className:"footer-column-title",children:"Documentation"}),d.jsxs("div",{className:"footer-column-links",children:[d.jsx("a",{href:"/learn/sdks/overview/introduction",className:"footer-link",children:"SDKs"}),d.jsx("a",{href:"/learn/docs/getting-started/overview",className:"footer-link",children:"Docs"}),d.jsx("a",{href:"/learn/docs/ai-features/ask-fern/overview",className:"footer-link",children:"Ask Fern"}),d.jsx("a",{href:"/learn/cli-api-reference/cli-reference/overview",className:"footer-link",children:"CLI Reference"})]})]}),d.jsxs("div",{className:"footer-column",children:[d.jsx("h4",{className:"footer-column-title",children:"API Definitions"}),d.jsxs("div",{className:"footer-column-links",children:[d.jsx("a",{href:"/learn/api-definitions/openapi/overview",className:"footer-link",children:"OpenAPI"}),d.jsx("a",{href:"/learn/api-definitions/asyncapi/overview",className:"footer-link",children:"AsyncAPI"}),d.jsx("a",{href:"/learn/api-definitions/openrpc/overview",className:"footer-link",children:"OpenRPC"}),d.jsx("a",{href:"/learn/api-definitions/grpc/overview",className:"footer-link",children:"gRPC"}),d.jsx("a",{href:"/learn/api-definitions/ferndef/overview",className:"footer-link",children:"Fern Definition"})]})]}),d.jsxs("div",{className:"footer-column",children:[d.jsx("h4",{className:"footer-column-title",children:"Resources"}),d.jsxs("div",{className:"footer-column-links",children:[d.jsx("a",{href:"https://buildwithfern.com/blog",className:"footer-link",children:"Blog"}),d.jsx("a",{href:"/learn/home#get-support",className:"footer-link",children:"Support"}),d.jsx("a",{href:"https://buildwithfern.com/pricing",className:"footer-link",children:"Pricing"})]})]}),d.jsxs("div",{className:"footer-column",children:[d.jsx("h4",{className:"footer-column-title",children:"Company"}),d.jsxs("div",{className:"footer-column-links",children:[d.jsx("a",{href:"https://brandfetch.com/buildwithfern.com",className:"footer-link",children:"Brand Kit"}),d.jsx("a",{href:"https://buildwithfern.com/privacy-policy",className:"footer-link",children:"Privacy Policy"}),d.jsx("a",{href:"https://buildwithfern.com/terms-of-service",className:"footer-link",children:"Terms of Service"})]})]}),d.jsxs("div",{className:"footer-column-socials",children:[d.jsxs("a",{href:"https://github.com/fern-api/fern",className:"footer-link",children:[d.jsx(V2,{className:"footer-social-icon dark:hidden"}),d.jsx(L2,{className:"footer-social-icon hidden dark:block"})]}),d.jsxs("a",{href:"https://x.com/buildwithfern",className:"footer-link",children:[d.jsx(q2,{className:"footer-social-icon dark:hidden"}),d.jsx(W2,{className:"footer-social-icon hidden dark:block"})]}),d.jsxs("a",{href:"https://www.linkedin.com/company/buildwithfern",className:"footer-link",children:[d.jsx(S2,{className:"footer-social-icon dark:hidden"}),d.jsx(U2,{className:"footer-social-icon hidden dark:block"})]})]})]})]})]})]}),Ei="fern-footer",Ri=async()=>{if(!document.getElementById("footer")){const t=document.createElement("div");t.setAttribute("id","fern-footer-wrapper"),t.setAttribute("data-react-component","true");let n=document.getElementById(Ei);n||(n=document.createElement("div"),n.setAttribute("id",Ei),document.body.appendChild(n)),n.insertBefore(t,n.firstChild),nf(t).render(d.jsx(gf.StrictMode,{children:d.jsx(R2,{})})),n&&(n.style.display="block")}};window.addEventListener("load",async()=>{await Ri(),new MutationObserver(async e=>{e.some(n=>n.type==="childList"&&!document.getElementById("fern-footer-wrapper"))&&await Ri()}).observe(document.body,{childList:!0,subtree:!0})}); + `}),d.jsxs("footer",{className:"footer",children:[d.jsxs("div",{className:"footer-top",children:[d.jsxs("a",{className:"footer-logo",href:"https://buildwithfern.com",children:[d.jsx(N2,{className:"footer-logo-img dark:hidden"}),d.jsx(T2,{className:"footer-logo-img hidden dark:block"})]}),d.jsxs("div",{className:"footer-status",children:[d.jsx(k2,{}),d.jsxs("a",{className:"soc2-badge",href:"https://security.buildwithfern.com/",children:[d.jsx(E2,{className:"soc2-badge-img"}),d.jsx("span",{className:"status-text",children:"Soc 2 Type II"})]})]})]}),d.jsxs("div",{className:"footer-links",children:[d.jsx("div",{className:"footer-bottom-text",children:" © 2026 Fern • Birch Solutions, Inc., a Postman company"}),d.jsxs("div",{className:"footer-columns",children:[d.jsxs("div",{className:"footer-column",children:[d.jsx("h4",{className:"footer-column-title",children:"Documentation"}),d.jsxs("div",{className:"footer-column-links",children:[d.jsx("a",{href:"/learn/sdks/overview/introduction",className:"footer-link",children:"SDKs"}),d.jsx("a",{href:"/learn/docs/getting-started/overview",className:"footer-link",children:"Docs"}),d.jsx("a",{href:"/learn/docs/ai-features/ask-fern/overview",className:"footer-link",children:"Ask AI"}),d.jsx("a",{href:"/learn/cli-api-reference/cli-reference/overview",className:"footer-link",children:"CLI Reference"})]})]}),d.jsxs("div",{className:"footer-column",children:[d.jsx("h4",{className:"footer-column-title",children:"API Definitions"}),d.jsxs("div",{className:"footer-column-links",children:[d.jsx("a",{href:"/learn/api-definitions/openapi/overview",className:"footer-link",children:"OpenAPI"}),d.jsx("a",{href:"/learn/api-definitions/asyncapi/overview",className:"footer-link",children:"AsyncAPI"}),d.jsx("a",{href:"/learn/api-definitions/openrpc/overview",className:"footer-link",children:"OpenRPC"}),d.jsx("a",{href:"/learn/api-definitions/grpc/overview",className:"footer-link",children:"gRPC"}),d.jsx("a",{href:"/learn/api-definitions/ferndef/overview",className:"footer-link",children:"Fern Definition"})]})]}),d.jsxs("div",{className:"footer-column",children:[d.jsx("h4",{className:"footer-column-title",children:"Resources"}),d.jsxs("div",{className:"footer-column-links",children:[d.jsx("a",{href:"https://buildwithfern.com/blog",className:"footer-link",children:"Blog"}),d.jsx("a",{href:"/learn/home#get-support",className:"footer-link",children:"Support"}),d.jsx("a",{href:"https://buildwithfern.com/pricing",className:"footer-link",children:"Pricing"})]})]}),d.jsxs("div",{className:"footer-column",children:[d.jsx("h4",{className:"footer-column-title",children:"Company"}),d.jsxs("div",{className:"footer-column-links",children:[d.jsx("a",{href:"https://brandfetch.com/buildwithfern.com",className:"footer-link",children:"Brand Kit"}),d.jsx("a",{href:"https://buildwithfern.com/privacy-policy",className:"footer-link",children:"Privacy Policy"}),d.jsx("a",{href:"https://buildwithfern.com/terms-of-service",className:"footer-link",children:"Terms of Service"})]})]}),d.jsxs("div",{className:"footer-column-socials",children:[d.jsxs("a",{href:"https://github.com/fern-api/fern",className:"footer-link",children:[d.jsx(V2,{className:"footer-social-icon dark:hidden"}),d.jsx(L2,{className:"footer-social-icon hidden dark:block"})]}),d.jsxs("a",{href:"https://x.com/buildwithfern",className:"footer-link",children:[d.jsx(q2,{className:"footer-social-icon dark:hidden"}),d.jsx(W2,{className:"footer-social-icon hidden dark:block"})]}),d.jsxs("a",{href:"https://www.linkedin.com/company/buildwithfern",className:"footer-link",children:[d.jsx(S2,{className:"footer-social-icon dark:hidden"}),d.jsx(U2,{className:"footer-social-icon hidden dark:block"})]})]})]})]})]})]}),Ei="fern-footer",Ri=async()=>{if(!document.getElementById("footer")){const t=document.createElement("div");t.setAttribute("id","fern-footer-wrapper"),t.setAttribute("data-react-component","true");let n=document.getElementById(Ei);n||(n=document.createElement("div"),n.setAttribute("id",Ei),document.body.appendChild(n)),n.insertBefore(t,n.firstChild),nf(t).render(d.jsx(gf.StrictMode,{children:d.jsx(R2,{})})),n&&(n.style.display="block")}};window.addEventListener("load",async()=>{await Ri(),new MutationObserver(async e=>{e.some(n=>n.type==="childList"&&!document.getElementById("fern-footer-wrapper"))&&await Ri()}).observe(document.body,{childList:!0,subtree:!0})}); diff --git a/fern/products/cli-api-reference/cli-changelog/2025-10-27.mdx b/fern/products/cli-api-reference/cli-changelog/2025-10-27.mdx index ac50400ed1..7a010c98b8 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-10-27.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-10-27.mdx @@ -3,7 +3,7 @@ ## 0.99.0 -**`(feat):`** Support enablements for custom/prod domains from docs.yml. Separate Slack, Discord, and docs Ask Fern deployments. +**`(feat):`** Support enablements for custom/prod domains from docs.yml. Separate Slack, Discord, and docs Ask AI deployments. ## 0.98.0 diff --git a/fern/products/dashboard/pages/overview.mdx b/fern/products/dashboard/pages/overview.mdx index 8b4ce7108d..d768758210 100644 --- a/fern/products/dashboard/pages/overview.mdx +++ b/fern/products/dashboard/pages/overview.mdx @@ -3,7 +3,6 @@ title: Dashboard overview description: Manage your Fern projects, settings, and team from a central dashboard. --- -
@@ -99,6 +100,7 @@ Monitor and analyze how developers interact with your documentation:
+
Set to ai to open the Ask AI panel.
The prompt to send to Ask AI, URL-encoded.
), + QUERY2: (The search term, URL-encoded.
) + }} +> + +```bash showLineNumbers={false} +# Open Ask AI side panel with a prompt +https://{{PAGE_URL}}?searchType={{SEARCH_TYPE}}&query={{QUERY1}} + +# Open search with a query +https://{{PAGE_URL}}?query={{QUERY2}} +``` + + + +| Parameter | Description | +| ------------ | ------------------------------------------------------------------------------- | +| `query` | The search query or prompt, URL-encoded. | +| `searchType` | Optional. Set to `ai` to open the Ask AI panel, or omit to open regular search. | + +Build a docs site quickly by importing your existing styling and specs.
- -
-
- Set up a documentation site in under 5 minutes.
-Build a docs site quickly by importing your existing styling and specs.
+ +
+
+ Set up a documentation site in under 5 minutes.
-
- Use one simple file to generate documentation that fits your brand.
-
+
+ + Use one simple file to generate documentation that fits your brand. +
Build your own components, enable Ask Fern, generate API references, and easily update your docs.
++ Build your own components, enable Ask AI, generate API references, and easily + update your docs. +
-
+
+
AI-native features including Ask Fern and AI-generated examples.
+AI-native features including Ask AI and AI-generated examples.
- AI search to find answers in your documentation instantly. + Generate a CLI from your API definition.
Community
@@ -98,14 +97,13 @@ curl -G https://fai.buildwithfern.com/slack/get-install \
一旦索引完成,Ask Fern 将使用这个精心策划的问答对来为类似问题的未来回应提供信息,随着时间的推移提供更准确的答案。
-
设置为 ai 以打开 Ask AI 面板。
发送给 Ask AI 的提示,URL 编码格式。
), + QUERY2: (搜索词,URL 编码格式。
) + }} +> + +```bash showLineNumbers={false} +# 打开 Ask AI 侧边面板并发送提示 +https://{{PAGE_URL}}?searchType={{SEARCH_TYPE}}&query={{QUERY1}} + +# 打开搜索并带查询 +https://{{PAGE_URL}}?query={{QUERY2}} +``` + + + +| 参数 | 描述 | +| ------------ | ------------------------------------------------------------ | +| `query` | 搜索查询或提示,URL 编码格式。 | +| `searchType` | 可选。设置为 `ai` 以打开 Ask AI 面板,或省略以打开常规搜索。 | + +设置为 ai 以打开 Ask AI 面板。
发送给 Ask AI 的提示,URL 编码格式。
), - QUERY2: (搜索词,URL 编码格式。
) - }} -> - -```bash showLineNumbers={false} -# 打开 Ask Fern 侧边面板并发送提示 -https://{{PAGE_URL}}?searchType={{SEARCH_TYPE}}&query={{QUERY1}} - -# 打开搜索并带查询 -https://{{PAGE_URL}}?query={{QUERY2}} -``` - - - -| 参数 | 描述 | -| --- | --- | -| `query` | 搜索查询或提示,URL 编码格式。 | -| `searchType` | 可选。设置为 `ai` 以打开 Ask AI 面板,或省略以打开常规搜索。 | -通过导入您现有的样式和规范来快速构建文档网站。
- -
-
- 在 5 分钟内建立一个文档网站。
-通过导入您现有的样式和规范来快速构建文档网站。
+ +
+
+ 在 5 分钟内建立一个文档网站。
-
- 使用一个简单的文件生成符合您品牌的文档。
-
+
+ 使用一个简单的文件生成符合您品牌的文档。
构建您自己的组件,启用 Ask Fern,生成 API 参考,并轻松更新您的文档。
+构建您自己的组件,启用 Ask AI,生成 API 参考,并轻松更新您的文档。
-
+
+
AI 原生功能,包括 Ask Fern 和 AI 生成的示例。
+AI 原生功能,包括 Ask AI 和 AI 生成的示例。