-
Notifications
You must be signed in to change notification settings - Fork 4
feat: Migrate documentation to Mintlify with enhanced content #25
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
2. updated main.yml_ 3. created .markdownlint.json 4. fix invalid url in main introduction
2. fix rust examples
dalmasonto
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.
- There is a huge gap, maybe a missing image on this page
http://localhost:3000/quickstart#rust-v4
Same issue on same link
- Encoding issue
There is some encoding issue here http://localhost:3000/schema_reference/signing_revision
Also http://localhost:3000/schema_reference/link_revision

- Primary color issue (Not huge but noticeable)
Here it uses blue yet primary color is green
Same on checkout aquafier button on the top navigation on hover, the underline is blue, should be white to match text color or green for primary color
Overal suggestion: Dark and light mode should use green as primary color. Currently, dark mode uses green while light mode uses blue as shown below
The links here are green but if you go light mode
Active link goes orange like and the color remains blue instead of dark(black) meaning it shows visited links as blue yet we don't have the same on dark mode (No visited links on dark mode)
- Suggestion: The api/schema reference title should have v4 slug to show its specifically for v4
The docs are okay, just a few minor changes on UI side and will be good to go
This PR migrates our documentation from Docusaurus to Mintlify, introducing a more modern and user-friendly experience.
Key highlights include:
- Platform Upgrade: Transition to Mintlify for a prettier, more intuitive documentation site.
- Improved V3 Docs: Existing Version 3 documentation has been significantly enhanced with more detail and
clarity.
- New V4 Docs: Comprehensive documentation for Version 4 is now available.
- Richer Examples: We've added numerous examples throughout the documentation to better illustrate concepts and
usage.