-
Notifications
You must be signed in to change notification settings - Fork 0
feat: revamp docs site #42
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
base: main
Are you sure you want to change the base?
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 pull request revamps the documentation site by replacing MDBook with Mintlify for a more organized documentation platform. The changes modernize the documentation structure, improve navigation, and enhance the user experience.
Key Changes
- Documentation platform migration: Complete transition from MDBook to Mintlify
- Content restructuring: Reorganization of all documentation into a structured format with proper navigation
- Enhanced styling: Addition of custom CSS for ZKsync branding and hero sections
Reviewed Changes
Copilot reviewed 68 out of 71 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| typedoc.json | Updated output directory and entry points for API reference generation |
| src/core/types/errors.ts | Added TODO comment for future error organization |
| src/core/constants.ts | Cleaned up comment formatting |
| src/adapters/ethers/sdk.ts | Added comprehensive JSDoc documentation for the EthersSdk interface |
| docs/style.css | Added custom CSS for ZKsync branding, hero sections, and UI components |
| docs/index.mdx | New homepage with hero section and navigation cards |
| docs/docs.json | Mintlify configuration file with complete navigation structure |
| Multiple *.mdx files | Complete documentation rewrite in Mintlify format |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
ci-run-tests LCOV of commit
|
Welcome to Codecov πOnce you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered βοΈ |
|
Note: look 2 merge after trial period |
What π»
Why β
Evidence π·
Include screenshots, screen recordings, or
consoleoutput here demonstrating that your changes work as intended