Modernize API doc template

[mtrezza]

New Feature / Enhancement Checklist

• I am not disclosing a vulnerability.
• I am not just asking a question.
• 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

[parse-github-assistant]

Thanks for opening this issue!

• 🎉 We are excited about your ideas for improvement!

[dblythy]

Sounds good to me. We can easily drop in the amendment from parse-community/minami#1 (comment)

[mtrezza]

That would be great, also see parse-community/minami#1 (comment) why I would rather not touch the current template.

[dblythy]

The same template will need to be applied to the JS repo too

[mtrezza]

Right, can we then point to the original dependency (rather than maintaining our own fork) and just add a config file to each repo?

[dblythy]

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.

[okobsamoht]

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

[mtrezza]

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.

[mtrezza]

@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.

[KodeyThomas]

@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

[mtrezza]

Haven't looked at TypeDoc, but it really depends on a feature comparison and what kind of visual themes they offer. What we see here looks pretty good to me already, if it's just a simple template change. In general, we want to switch to another docs framework, see forum.

[parseplatformorg]

🎉 This change has been released in version 6.1.0-alpha.8

[parseplatformorg]

🎉 This change has been released in version 6.1.0-beta.2

[parseplatformorg]

🎉 This change has been released in version 6.1.0

[parseplatformorg]

🎉 This change has been released in version 6.1.0-alpha.9

[parseplatformorg]

🎉 This change has been released in version 6.3.0-beta.1

[parseplatformorg]

🎉 This change has been released in version 6.3.0-alpha.1

[parseplatformorg]

🎉 This change has been released in version 6.3.0