Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Algolia Search Visual Papercuts #1712

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

RohinBhargava
Copy link
Member

Fixes FER-3414

Short description of the changes made

Addresses:

  • Version path filtering (cannonical url taken into account)
  • Page blocks being empty
  • Show more being in wrong place
  • Duplicated page/sections
  • Anchor links in titles

To be done:

  • Markdown conversion into MDAST and implement marking search within, for better results rendering

What was the motivation & context behind this PR?

  • Customer asks

How has this PR been tested?

Screen.Recording.2024-10-24.at.7.10.01.PM.mov

Copy link

vercel bot commented Oct 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Updated (UTC)
fern-shell ⬜️ Ignored (Inspect) Oct 24, 2024 11:11pm

@RohinBhargava RohinBhargava had a problem deploying to Preview - app-dev.buildwithfern.com October 24, 2024 23:11 — with GitHub Actions Error
@RohinBhargava RohinBhargava had a problem deploying to Preview - app.buildwithfern.com October 24, 2024 23:11 — with GitHub Actions Error
const markdownTree = getMarkdownSectionTree(rawMarkdown, title);
const description = truncateToBytes(
frontmatter.description ?? frontmatter.subtitle ?? markdownTree.content ?? content,
Copy link
Contributor

Choose a reason for hiding this comment

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

this is going to delete the content and prefer the frontmatter instead. you probably want to concat all of these instead. see: https://github.com/fern-api/fern-platform/blob/main/packages/ui/fern-docs-search-server/src/algolia/records/generateMarkdownRecords.ts#L32-L53

Copy link
Member Author

Choose a reason for hiding this comment

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

I actually mean to truncate -- since there are section records, the page no longer needs these. Customer suggested we use the frontmatter description or subtitle, here

Copy link
Contributor

@abvthecity abvthecity left a comment

Choose a reason for hiding this comment

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

description field

@fern-bot fern-bot had a problem deploying to Preview - app-dev.buildwithfern.com October 25, 2024 22:20 — with GitHub Actions Failure
@fern-bot fern-bot had a problem deploying to Preview - app.buildwithfern.com October 25, 2024 22:20 — with GitHub Actions Failure
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.

3 participants