Skip to content

docs: jsdoc clean theme #8021

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

Closed

Conversation

okobsamoht
Copy link

New Pull Request Checklist

Issue Description

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

TODOs before merging

  • Check graphical identity

@parse-github-assistant
Copy link

parse-github-assistant bot commented Jun 1, 2022

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.

Copy link
Member

@mtrezza mtrezza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this was correctly installed. There are no changes to package-lock.

@okobsamoht
Copy link
Author

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

@Moumouls
Copy link
Member

Moumouls commented Jun 7, 2022

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 ?

@mtrezza
Copy link
Member

mtrezza commented Jun 7, 2022

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

Copy link
Author

@okobsamoht okobsamoht left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

restored package-lock file from current parse-server/alpha

@okobsamoht okobsamoht changed the title jsdoc clean theme doc: jsdoc clean theme Jun 26, 2022
@okobsamoht okobsamoht changed the title doc: jsdoc clean theme docs: jsdoc clean theme Jun 26, 2022
@okobsamoht okobsamoht requested a review from mtrezza June 26, 2022 08:57
Copy link
Member

@mtrezza mtrezza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Moumouls
Copy link
Member

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 👍

@okobsamoht
Copy link
Author

okobsamoht commented Jul 9, 2022

hi @Moumouls
bien sûr.

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

@okobsamoht
Copy link
Author

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: #8017

i'll try the customization in the current theme

@mtrezza
Copy link
Member

mtrezza commented Apr 29, 2023

Closing via #8519

@mtrezza mtrezza closed this Apr 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants