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

intermediate fix: algolia search improvement #1499

Merged
merged 5 commits into from
Sep 18, 2024

Conversation

RohinBhargava
Copy link
Member

Fixes FER-3278

Short description of the changes made

  • Adds the concept of anchor fields to endpoints
  • Adds the concept of headings to markdown pages
  • Segments and filters the hit results by category

What was the motivation & context behind this PR?

  • Need to test this indexing in algolia

How has this PR been tested?

  • Need to test in FDR

Copy link

vercel bot commented Sep 18, 2024

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

7 Skipped Deployments
Name Status Preview Comments Updated (UTC)
app-dev.buildwithfern.com ⬜️ Ignored (Inspect) Sep 18, 2024 7:44pm
app-slash.ferndocs.com ⬜️ Ignored (Inspect) Sep 18, 2024 7:44pm
app.buildwithfern.com ⬜️ Ignored (Inspect) Sep 18, 2024 7:44pm
app.ferndocs.com ⬜️ Ignored (Inspect) Sep 18, 2024 7:44pm
dashboard-dev.buildwithfern.com ⬜️ Ignored (Inspect) Sep 18, 2024 7:44pm
dashboard.buildwithfern.com ⬜️ Ignored (Inspect) Sep 18, 2024 7:44pm
icons.ferndocs.com ⬜️ Ignored (Inspect) Sep 18, 2024 7:44pm

Copy link

github-actions bot commented Sep 18, 2024

Playwright test results

passed  1 passed

Details

stats  1 test across 1 suite
duration  9 seconds
commit  c3f1148

@RohinBhargava RohinBhargava marked this pull request as ready for review September 18, 2024 19:50

export type ValidSegmentationKeys = "endpoints" | "pages" | "fields";

const SEARCH_SEGMENTATION_ATOM = atom<"endpoints" | "pages" | "fields">("endpoints");
Copy link
Contributor

Choose a reason for hiding this comment

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

atom

Copy link

PR Preview

Copy link

📦 Next.js Bundle Analysis for fern-platform-monorepo

This analysis was generated by the Next.js Bundle Analysis action. 🤖

🎉 Global Bundle Size Decreased

Page Size (compressed)
global 240.61 KB (🟢 -16.67 KB)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

Two Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load % of Budget (350 KB)
/dynamic/[host]/[[...slug]] 80.41 KB 321.02 KB 91.72% (🟡 +0.94%)
/static/[host]/[[...slug]] 80.41 KB 321.02 KB 91.72% (🟡 +0.94%)
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.

Copy link

Playwright test results

passed  80 passed
flaky  1 flaky

Details

stats  81 tests across 3 suites
duration  1 minute, 40 seconds
commit  c3f1148

Flaky tests

chromium › smoke/versioned-docs.spec.ts › Check if https://humanloop.com/docs/v5/api-reference is online

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.

2 participants