-
Notifications
You must be signed in to change notification settings - Fork 51
make website more future-proof #2641
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR modernizes the Mithril documentation website by updating dependencies, streamlining swizzled components, and introducing automated component upgrade tooling. The changes prepare the website for future maintenance by removing unnecessary customizations and providing better upgrade workflows.
Key changes include:
- Removal of redundant swizzled components that had no customizations
- Addition of automated upgrade tooling for maintaining customized components
- Dependency upgrades and documentation updates
Reviewed Changes
Copilot reviewed 22 out of 23 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/website/upgrade/*.patch | Patch files containing custom modifications to be applied during component upgrades |
| docs/website/src/theme/*/index.tsx | Removal of swizzled components that revert to base Docusaurus functionality |
| docs/website/package.json | Dependency version upgrades and reorganization |
| docs/website/README.md | Updated documentation with current development commands and versioning workflow |
| docs/website/Makefile | New automation targets for component upgrades and maintenance tasks |
Comments suppressed due to low confidence (2)
docs/website/upgrade/theme-navbar-content.patch:23
- The function parameter should be typed. Consider using
props: ComponentProps<'div'>or define a specific interface for better type safety.
import NavbarMobileSidebarToggle from "@theme/Navbar/MobileSidebar/Toggle";
docs/website/upgrade/theme-navbar-content.patch:32
- The function parameter should be typed. The original code used
{ children }: Propswhich provides proper TypeScript typing.
// TODO temporary casting until ThemeConfig type is improved
dlachaume
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
a783f78 to
87171fa
Compare
jpraynaud
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
It used the invite link for Hydra instead of the one for Mithril.
as docusaurus will automatically use the components from the base theme instead, reducing maintenance cost.
to facilate upgrading of swizzled components if their base code from docusaurus change.
c3118dd to
05dd934
Compare
…recipes Allowing to run them separatly
05dd934 to
2998a1d
Compare
Content
This PR:
Readme, that was referencing long removed command likeyarn start, to latest development statemake swizzled-components-upgradeto facilitate upgrade of components swizzled since merge of the new website design (filip(feat): docs site redesign #2597)Details
make swizzled-components-upgradegoal is to automate as much as possible of the steps necessary to align swizzled components with their base docusaurus part.It run the following steps automatically:
npm run swizzle @docusaurus/theme-classic {COMPONENT/PATH} -- --eject --typescriptfor all components, this retrieve them as they are currently in the current docusaurus versionNote
Those steps can be run separately have they each have a dedicated makefile recipe:
swizzled-components-clean,reswizzle-components,swizzled-components-apply-patches(the later run for each patch amake upgrade/PATCH_NAME.patchrecipe)Pre-submit checklist
Issue(s)
Relates to #2622