-
Notifications
You must be signed in to change notification settings - Fork 2
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
Move detailed docs to vitepress #131
Comments
@benjaminbojko Looks like reimplementing the autogenerated docs will be a bit more difficult than anticipated. There are a couple of approaches, but none seem to fully match our needs:
Overall both options could potentially work, but getting either setup will take a good chunk of time. I'm not sure that the benefit of automation here outweighs the cost of dev and maintenance when compared to just manually writing up the markdown files. |
Oof yeah. It was nice to have all the various options listed out, but the main challenge with our docs is actually making it clear how to fit all the pieces together. I think with #116 and the new config autocomplete, we can probably make the documentation more focused on use cases, principles, etc. Let's close this one as won't fix. |
Whoops realized that this was the larger vitepress issue and not just for jsdocs :) We should continue with vitepress, but remove all dependencies to jsdocs (scripts, templates, etc). |
Resolved by #179 |
Discussed in #116
The text was updated successfully, but these errors were encountered: