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

Proper documentation #802

Open
7 tasks
saiichihashimoto opened this issue Oct 28, 2024 · 0 comments
Open
7 tasks

Proper documentation #802

saiichihashimoto opened this issue Oct 28, 2024 · 0 comments
Labels
help wanted Please help me! I'm lonely.

Comments

@saiichihashimoto
Copy link
Owner

saiichihashimoto commented Oct 28, 2024

While I've put some effort into the _README.md/README.md, it's not the best. Ideally, we'd be on some hosted auto-generated site that looks nice, similar to zod.dev or other documentation sites.

Nice to haves:

  • Write documentation once, get npm, github READMEs, and hosted documentation.
  • For npm, should have the documentation per package.
  • For github, should have the documentation per package in README.
  • For the site, not entirely sure but it should certainly address all the packages.
  • Some kind of templating, since we'll want to repeat some content between the packages.
  • Auto deployment, I'm sure we can handle this with semantic-release.
  • I bought sanity-typed.dev, have it hosted there

I don't know how these sites tend to do it and I'd love the experience of someone who's done this before!

@saiichihashimoto saiichihashimoto added the help wanted Please help me! I'm lonely. label Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Please help me! I'm lonely.
Projects
None yet
Development

No branches or pull requests

1 participant