docs: Add initial fern migration#4325
Conversation
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
| children, | ||
| }: { | ||
| variant?: TagVariant; | ||
| children: React.ReactNode; |
There was a problem hiding this comment.
Bug: React.ReactNode is used here without importing React. Other components in this PR explicitly avoid importing React because "the react module is not resolvable in Fern's build." This will cause a build error.
| children: React.ReactNode; | |
| children: import("react").ReactNode; |
Alternatively, match the pattern in NotebookViewer.tsx and use a type-only import:
import type { ReactNode } from "react";then use children: ReactNode.
| * <Authors ids={authors} /> | ||
| */ | ||
|
|
||
| import { authors } from "./devnotes/authors-data"; |
There was a problem hiding this comment.
Bug: This imports from "./devnotes/authors-data" but no devnotes/ directory exists under docs/fern/components/ in this PR. If this component is rendered, it will fail at build time with a module-not-found error. Either add the missing authors-data module to this PR, or guard the import so the component degrades gracefully when the module is absent.
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout PR | ||
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 |
There was a problem hiding this comment.
Bug: This is pinned to actions/checkout v4.2.2, while the repo convention (and the other three new workflows in this PR) uses @v6. This should be updated for consistency and to get the latest features/fixes.
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| uses: actions/checkout@v6 |
| /** | ||
| * SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| * SPDX-License-Identifier: LicenseRef-NvidiaProprietary | ||
| */ |
There was a problem hiding this comment.
Nit: This file uses LicenseRef-NvidiaProprietary while all other new components in this PR use Apache-2.0. Is this intentional? The rest of the repo is Apache-2.0 licensed.
|
Code Review: 1) Bug - Tag.tsx uses React.ReactNode without importing React (Tag.tsx:41), will cause build error. 2) Bug - Authors.tsx imports missing devnotes/authors-data module (Authors.tsx:23). 3) Bug - fern-docs-preview-build.yml pins actions/checkout to v4.2.2, repo convention is v6. 4) License mismatch - CustomFooter.tsx uses LicenseRef-NvidiaProprietary, other components use Apache-2.0. 5) Duplicate nav titles in 0.4.2.yml (lines 13-15), two entries both titled Performance. Suggested test cases: No perf tests impacted. |
What does this PR do ?
docs: Add initial fern migration
Used docs team's fern migrate skill to do this. Had to resolve a few issues with agent like ensuring rendering of github badges were horizontal.
The docs team will enable a staging site for us to evaluate before we choose to cut over
To render locally
Changelog
GitHub Actions CI
See the CI section in the Contributing doc for how to trigger the CI. A Nvidia developer will need to approve and trigger the CI for external contributors.
Before your PR is "Ready for review"
Pre checks:
If you haven't finished some of the above items you can still open "Draft" PR.
Additional Information