New Documentation Site #3019
babakfp
started this conversation in
Show and tell
Replies: 3 comments
-
This seems more like a discussion, is it ok if I move it there? |
Beta Was this translation helpful? Give feedback.
0 replies
-
Hi. Sure, feel free to do so. |
Beta Was this translation helpful? Give feedback.
0 replies
-
Hey. Can you please take a look into this? Thanks. Things are up to date with the latest commit on this repo. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Hi
I'm working on this new documentation site for Zod:
https://zod-eight.vercel.app
The problems I have with the current site are:
I'm using VitePress for documentation generation, which is fantastic.
Content
I moved all of the
.md
files to the new site. So, if any changes need to be made to the files likeREADME.md
,MIGRATION.md
,CONTRIBUTING.md
(etc), they need to be made in the new sites Markdown files.Sponsors
About sponsors. I don't know how these changes are going to affect the impressions promised in this page. Are these changes going to impact the number of sponsors or the promised impressions number in a bad way? I don't know.
On the new site, there are three places the sponsors are shown, the home page, the sponsors page, also the main guide page (the page that contains content of README.md).
I think it would be nice to show all sponsors on the site, but it seems like GitHub doesn't provide an API for it (maybe I couldn't find it). So, does anyone know how to do this?
i18n
I don't know
zh
, but it seemed like it needs some rewrites. Maybe it's a good idea to rewrite the original docs and after that update thezh
docs too.Issues
If the user changes the language on a page that is not yet translated, then a 404 error is going to be shown, so there is no fallback to the default language. There is a workaround but it's not a nice one.
vuejs/vitepress#3312
I would also link to build a playground (Add a zod.dev/playground #2710).I tried implementing this but things didn't work...
Which Discord link to pick? https://discord.gg/KaSRdyX2vc or https://discord.gg/RcG33DQJdf.
One of the links is used here:
And the other one is used here:
Should I keep them as is in the new docs, or only use one? they both link to the same discord server.
Replace
|
with-
if possible. (SEO).gtag.
I may be wrong, but this code looks wrong 🤔:
Beta Was this translation helpful? Give feedback.
All reactions