Skip to content
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

Translate docs to Fumadocs #1111

Open
ssalbdivad opened this issue Aug 30, 2024 · 2 comments
Open

Translate docs to Fumadocs #1111

ssalbdivad opened this issue Aug 30, 2024 · 2 comments
Labels
external-contributor-friendly Doesn't rely heavily on contextual knowledge of ArkType (may still be complex)

Comments

@ssalbdivad
Copy link
Member

I like the all the styling of the current Starlight implementation, but I've found working with Astro to be a pain in-editor, and I find the components to be opaque/untuitive. Would much rather just be writing and using React.

Fumadocs (https://fumadocs.vercel.app) looks great, but would likely require a fair amount of translating to get the styles over from the Starlight implementation. Would also require some customization e.g. to preserve the current header layout/animation since at least by default Fumadocs only has a sidebar.

@ssalbdivad ssalbdivad added the external-contributor-friendly Doesn't rely heavily on contextual knowledge of ArkType (may still be complex) label Aug 30, 2024
@holic
Copy link
Contributor

holic commented Sep 1, 2024

I don't know what your requirements are but have you seen Vocs?

@ssalbdivad
Copy link
Member Author

@holic Looks nice. Honestly I basically want the docs to mostly just look the way they do now but be written in a framework that just embraces React, so either would fit the bill.

I guess one nice thing about Fumadocs is that this built-in dropdown concept could be a nice way to split up different projects like @ark/attest and @ark/schema

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
external-contributor-friendly Doesn't rely heavily on contextual knowledge of ArkType (may still be complex)
Projects
Status: Backlog
Development

No branches or pull requests

2 participants