parse-server
parse-server copied to clipboard
parse-community
Modernize API doc template
New Feature / Enhancement Checklist
- [x] I am not disclosing a vulnerability.
- [x] I am not just asking a question.
- [x] I have searched through existing issues.
Current Limitation
The API docs are generated from JSDoc. We are currently using our forked version of an JSDOc template that seems pretty outdated and not well maintained.
Feature / Enhancement Description
Switch to a more modern template that is maintained and improves usability, for example:
- https://github.com/ankitskvmdam/clean-jsdoc-theme
Example Use Case
n/a
Alternatives / Workarounds
n/a
Thanks for opening this issue!
- 🎉 We are excited about your ideas for improvement!
![parse-github-assistant[bot] avatar](https://avatars.githubusercontent.com/in/136195?v=4 "Published by a pub.dev verified publisher"){kind=small}
Sounds good to me. We can easily drop in the amendment from https://github.com/parse-community/minami/pull/1#issuecomment-1140267604
That would be great, also see https://github.com/parse-community/minami/pull/1#issuecomment-1140267604 why I would rather not touch the current template.
Right, can we then point to the original dependency (rather than maintaining our own fork) and just add a config file to each repo?
There were some changes to the template which may have been the reason why there is a fork.
The main changes seem to be to add @interface to the nav bar.
I'v tested the clean-jsdoc-theme.
you can take a look here:
https://6297b4ac43cc1f0062fbe19e--parse-server-doc.netlify.app/
here are some screenshots
mobile
desktop
We'd need to make sure that all content is included in the new template; @dblythy mentioned that there was some customization in the old template.
@parse-community/server Anyone wants to pick this up for Parse Server 6? While it's not required for release, it would still be nice to have a modern docs layout with the new release.
@parse-community/server Anyone wants to pick this up for Parse Server 6? While it's not required for release, it would still be nice to have a modern docs layout with the new release.
Have you had a look into TypeDoc it's made for TypeScript but works fine in a JS project, I've used it in a few projects and it's worked pretty well. However, I do think we need a general refactor of the docs to make things a bit more clear for new users.
Happy to pick this one up if I get a bit of free time before Jan
