Skip to content

feat(docsearch-website): Updated docs#2662

Merged
dylantientcheu merged 3 commits into
v4from
feat/updated-documentation
Jul 10, 2025
Merged

feat(docsearch-website): Updated docs#2662
dylantientcheu merged 3 commits into
v4from
feat/updated-documentation

Conversation

@NatanTechofNY
Copy link
Copy Markdown
Collaborator

@NatanTechofNY NatanTechofNY commented Jul 9, 2025

Changelog

✨ New & Updated Documentation Pages

  • create-crawler.mdx

    • Added a step-by-step guide for new DocSearch apps (after July 2nd, 2024) to add domains, verify ownership, create a crawler, and run a test crawl.
    • Included an info/caution box about the 7-day domain verification grace period and DocSearch approval.
    • Added a screenshot for domain management.
    • Updated links to use the new Crawler UI dashboard.
  • crawler-configuration-visual.mdx

    • Modernized to match the new Algolia Crawler UI and documentation style.
    • Updated/added sections:
      • Trigger a new crawl
      • Monitor your crawls
      • Update your config (now includes both the Visual Configuration UI and the code editor, with screenshots)
      • Search preview (placeholder)
      • URL tester
      • New: DocSearch Tab (with screenshot and explanation)
      • New: Suggestions (with screenshot and explanation)
    • Updated image references to match new UI screenshots.
    • Updated links to point to the new Crawler UI dashboard.
  • manage-your-crawls.mdx

    • Marked as deprecated with a prominent caution at the top.
    • Added links to the new Crawler UI and updated documentation.
    • Updated references to the new dashboard.
  • crawler.mdx

    • Modernized to match the latest Algolia documentation.
    • Added a caution for legacy users and clear links to new getting started/configuration docs.
    • Removed outdated and redundant content.
    • Updated links to use the new Crawler UI dashboard.
  • v4/askai.mdx

    • Clarified that AskAI allows users to bring their own LLM provider/model and API keys, and use LLMs with the context of any Algolia index.
    • Refined the “Overview” and “Why you should use AskAI” sections to avoid repetition and clearly separate technical features from business/user benefits.

🖼️ Screenshots and Visuals

  • Added/updated image references for new Crawler UI features:
    • DocSearch tab (crawler-visual-docsearch.png)
    • Suggestions tab (crawler-visual-suggestions.png)
    • Other updated UI screenshots for each section

🧭 Sidebar/Navigation

  • Ensured new pages are referenced in the sidebar for discoverability.

🛠️ General Improvements

  • Improved clarity, structure, and alignment with the latest Algolia documentation style.
  • Added or updated admonitions (info/caution) for user guidance and migration context.
  • Linked to official Algolia documentation and FAQs where appropriate.
  • Updated various links throughout the docs to point to the new Crawler UI dashboard (https://dashboard.algolia.com/crawler).

@netlify
Copy link
Copy Markdown

netlify Bot commented Jul 9, 2025

Deploy Preview for docsearch ready!

Name Link
🔨 Latest commit 604afdf
🔍 Latest deploy log https://app.netlify.com/projects/docsearch/deploys/686ec98f1111a100087408a6
😎 Deploy Preview https://deploy-preview-2662--docsearch.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@NatanTechofNY NatanTechofNY self-assigned this Jul 9, 2025
@dylantientcheu dylantientcheu merged commit 1b09a56 into v4 Jul 10, 2025
9 of 10 checks passed
@dylantientcheu dylantientcheu deleted the feat/updated-documentation branch July 10, 2025 11:30
dylantientcheu added a commit that referenced this pull request Jul 17, 2025
* feat(v4): add new UI (#2555)

* feat: add new footer ui

* feat: add new search box ui

* feat: add searchbox actions

* feat: add start screen

* feat: add no results screen

* feat: add new card ui

* feat: add new icons

* feat: add new key press class

* fix: cypress tests

* fix: circleci

* fix: circleci

* fix: close aria label

* fix: circleci

* fix: remove unused classes

* fix: circleci

* feat: update version

* feat: add new dark mode ui

* fix: colors

* fix: design review

* fix: hit title length

* fix: improve accessibility

* fix: ci

* chore: increase bundle size threshold

* fix: css

* feat(v4): ask-ai foundations ✨ (#2574)

* feat(v4): docsearch askAI context (#2587)

* fix(v4): ask ai updates (#2654)

* feat(v4): update beta documentation (#2659)

* chore: release v4.0.0-beta.0 (#2660)

* fix: make release run on branches like v4

* chore: release v4.0.0-beta.0

* hotfix: closing on askai error

* chore: release v4.0.0-beta.1 (#2661)

* fix: add a section on models

* fix: update to `<package>@beta`

* feat(docsearch-website): Updated docs (#2662)

* feat(v4): update the landing page (#2665)

* fix: beta in readme

* feat: added glow around the search bar and a little copy above the keyboard

* feat: add glow around the search bar and copy above the keyboard

* fix: Add more styling

* fix: polishing v4 (#2667)

* chore: release v4.0.0-beta.2 (#2668)

* fix: update docusaurus tarballs

* fix(website): update docusaurus tarballs

* fix: mobile search bar

---------

Co-authored-by: Vasco Bettencourt <32492444+vascobettencourt@users.noreply.github.com>
Co-authored-by: Natan Yagudayev <natanyagudayev@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants