parse-server icon indicating copy to clipboard operation
parse-server copied to clipboard

Published 20 hours ago • verified publisher icon parse-community

docs: jsdoc clean theme

Open okobsamoht opened this issue 3 years ago • 7 comments

New Pull Request Checklist

  • [x] I am not disclosing a vulnerability.
  • [x] I am creating this PR in reference to an issue.

Issue Description

Modernize API doc template change the jsdoc theme form the @parse/minami to clean-jsdoc-theme

TODOs before merging

  • [x] Check graphical identity

okobsamoht avatar Jun 01 '22 20:06 okobsamoht

Thanks for opening this pull request!

  • ❌ Please edit your post and use the provided template when creating a new pull request. This helps everyone to understand your post better and asks for essential information to quicker review the pull request.

parse-github-assistant[bot] avatar Jun 01 '22 20:06 parse-github-assistant[bot]

oh! sorry. i forgot commiting the package-lock.json as i installed everything via yarn. i'll add it...

okobsamoht avatar Jun 02 '22 22:06 okobsamoht

HI @okobsamoht , i think you need to restore the package lock from alpha branch. Also you have changed the lockfile version to v2.

To easily avoid a change to v2, use nvm and switch to Node 14 then run npm i

@mtrezza what do you think about switching to lock v2 in a separate PR since it's now the default version since Node 16/Npm 8 ?

Moumouls avatar Jun 07 '22 16:06 Moumouls

@mtrezza what do you think about switching to lock v2 in a separate PR since it's now the default version since Node 16/Npm 8 ?

As long as we're supporting a Node version that uses v1 natively, we stick with v1 (despite backwards-compatibility).

mtrezza avatar Jun 07 '22 20:06 mtrezza

thanks @okobsamoht for the package lock restoration. Is it possible to add some screenshot of the new jsdoc theme here ? It could helps to understand the before and after 👍

Moumouls avatar Jun 26 '22 11:06 Moumouls

hi @Moumouls bien sûr.

[removed duplicate lengthy comment, please see screenshots already posted in the issue]

okobsamoht avatar Jul 09 '22 03:07 okobsamoht

Isn't there a related open issue for this PR? I can't find the ref in the PR description.

I also don't believe this is the full PR because I remember in the issue I've mentioned a customization in the current template. That's why we need the issue referenced in the PR.

here is the issure: https://github.com/parse-community/parse-server/issues/8017

i'll try the customization in the current theme

okobsamoht avatar Jul 09 '22 03:07 okobsamoht

Closing via https://github.com/parse-community/parse-server/pull/8519

mtrezza avatar Apr 29 '23 14:04 mtrezza