Skip to content

docs(ask-fern): document the standalone AskAiChat widget - #6644

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1786727431-ask-ai-chat-widget
Open

docs(ask-fern): document the standalone AskAiChat widget#6644
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1786727431-ask-ai-chat-widget

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

AskAiChat is a new export from the published @fern-api/search-widget npm package that embeds Ask Fern on its own, without any keyword-search UI. It renders as a floating card anchored to a corner of the viewport (a bottom drawer on small screens), so customers can drop Ask Fern into a product site, dashboard, or marketing site outside their docs site without disturbing that page's layout. Previously the only embeddable option was the full search modal, which forced search-as-a-feature on teams that only wanted Ask Fern. SearchModal is unchanged, and Fern-hosted docs sites are unaffected.

Implements docs for: feat(docs): standalone Ask AI chat widget (floating overlay) (fern-api/fern-platform#13748)

Changes

  • fern/products/docs/pages/ask-fern/search-widget.mdx (canonical page): intro now names both exports so readers can pick between search + Ask AI (SearchModal) and Ask AI only (AskAiChat). New ## Ask AI chat section covers the minimal integration, the floating vs. inline trigger (fern-ask-ai-button), keyboard shortcuts, citations, expand/collapse, and a table of the --fern-ask-ai-* CSS custom properties with defaults. The props reference is split into ## SearchModal properties (unchanged content) and a new ## AskAiChat properties.
  • fern/products/docs/pages/changelog/2026-08-14.mdx: Docs changelog entry (ai, search) with a CTA to #ask-ai-chat, requested by the source PR author.
  • fern/products/docs/pages/ask-fern/what-is-ask-fern.mdx: card description updated to mention Ask AI chat alongside search. The customization/search.mdx pointer already links to the widget page and stays as-is — that section is specifically about search integration.

Lint and validate are clean: pre-commit run --files ... passes (remaining Vale output is pre-existing suggestions plus sentence-case suggestions on the component-name headings), and fern check --warnings reports no new docs warnings.

Link to Devin session: https://app.devin.ai/sessions/f4a17882e2744c15b4125bf45e5cbc26

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

Replace `https://docs.example.com` with your `domain`. The Algolia wildcards cover the hosts the widget resolves at runtime: `<app-id>-dsn.algolia.net` and `<app-id>-1.algolianet.com` through `<app-id>-3.algolianet.com`.

## Properties
## SearchModal properties

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'SearchModal properties' should use sentence-style capitalization.

Additional click handler that runs before the modal opens.
</ParamField>

## AskAiChat properties

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'AskAiChat properties' should use sentence-style capitalization.

@github-actions

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants