Skip to content

Conversation

@dutterbutter
Copy link
Owner

What πŸ’»

  • Replace mdbook with mintlify

Why βœ‹

  • Much more organized

Evidence πŸ“·

Include screenshots, screen recordings, or console output here demonstrating that your changes work as intended

Copilot AI review requested due to automatic review settings October 10, 2025 20:14
Copy link
Contributor

Copilot AI left a 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.

@github-actions
Copy link

github-actions bot commented Oct 14, 2025

ci-run-tests LCOV of commit d18252f during ci-run-tests #118

Summary coverage rate:
  lines......: 86.9% (9657 of 11115 lines)
  functions..: no data found
  branches...: no data found

Files changed coverage rate:
                                                                    |Lines       |Functions  |Branches    
  Filename                                                          |Rate     Num|Rate    Num|Rate     Num
  ========================================================================================================
  src/adapters/ethers/resources/withdrawals/routes/eth.ts           | 0.0%     47|    -     0|    -      0
  src/adapters/ethers/sdk.ts                                        | 0.0%     23|    -     0|    -      0
  src/core/types/errors.ts                                          | 0.0%    114|    -     0|    -      0

@codecov-commenter
Copy link

codecov-commenter commented Oct 16, 2025

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 β˜‚οΈ

@dutterbutter
Copy link
Owner Author

Note: look 2 merge after trial period

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.

3 participants