Skip to content

Conversation

devin-ai-integration[bot]
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Oct 18, 2025

docs: add ai-search configuration documentation

Summary

Adds documentation for the new ai-search configuration options in docs.yml that were introduced in PR #9788 and initially documented in PR #1302.

Changes:

  1. Added new "AI search configuration" section to the docs.yml reference page (what-is-docs-yml.mdx) with concise ParamField descriptions for location and datasources fields
  2. Updated the Ask Fern getting started page (what-is-ask-fern.mdx) to clarify that Ask Fern can be configured via both the Dashboard and docs.yml (not one or the other)

The documentation now provides a comprehensive reference for the ai-search configuration block while keeping ParamField descriptions concise, with auxiliary information in a Note callout that links to the detailed locations-and-datasources page.

Review & Testing Checklist for Human

This is a yellow risk PR (documentation only, but accuracy is important).

  • Verify internal links work correctly: Test that the link from what-is-ask-fern.mdx to #ai-search-configuration navigates properly to the new section, and confirm the link to /learn/ask-fern/configuration/locations-and-datasources in the Note works
  • Test the actual configuration: Create a test docs.yml with the ai-search block using the documented options (location: [docs, slack, discord] and datasources) to verify the syntax and options are accurate
  • Check rendering: Verify the ParamField components and Note callout render correctly with proper formatting

Test Plan

  1. Deploy to preview and navigate to both updated pages
  2. Click the link from what-is-ask-fern page to verify it jumps to the new AI search configuration section
  3. Create a test docs.yml with the ai-search configuration and run fern generate --docs --preview to verify it works

Notes

@devin-ai-integration
Copy link
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 and CI monitoring

@github-actions
Copy link
Contributor

@github-actions
Copy link
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