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

proposal: docs register v3 #1643

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

proposal: docs register v3 #1643

wants to merge 5 commits into from

Conversation

abvthecity
Copy link
Contributor

@abvthecity abvthecity commented Oct 10, 2024

See:
https://github.com/fern-api/fern-platform/blob/ajiang/publish-v2-types/fern/apis/fdr/definition/docs/v3/__package__.yml

Major differences from the V2 API

  1. registering docs will now upload all markdown files, along with public files to S3
  2. navigation v2 is used
  3. api references are not returned
  4. docs registration no longer revalidates— revalidation will be handled separately by the client
  5. all endpoints require auth

Copy link

github-actions bot commented Oct 10, 2024

PR Preview

Copy link

github-actions bot commented Oct 10, 2024

📦 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 162.69 KB (🟢 -94.59 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!

New Page Added

The following page was added to the bundle from the code in this PR:

Page Size (compressed) First Load % of Budget (350 KB)
/404 332 B 163.01 KB 46.58%

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]] 52.68 KB 215.37 KB 61.53% (🟢 -6.98%)
/static/[host]/[[...slug]] 52.68 KB 215.37 KB 61.53% (🟢 -6.98%)
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

github-actions bot commented Oct 10, 2024

Playwright test results

passed  1 passed

Details

stats  1 test across 1 suite
duration  9 seconds
commit  3d720f2

Copy link

github-actions bot commented Oct 10, 2024

Playwright test results

passed  81 passed

Details

stats  81 tests across 3 suites
duration  1 minute, 11 seconds
commit  49a0d5a

Copy link

@abvthecity abvthecity changed the title stash: docs v3 proposal: docs register v3 Oct 10, 2024
@abvthecity abvthecity marked this pull request as ready for review October 10, 2024 23:11
@abvthecity abvthecity requested a review from dsinghvi as a code owner October 10, 2024 23:11
Copy link

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.

1 participant