Skip to content

feat: add check if version is latest #1

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

Merged
merged 1 commit into from
May 28, 2022

Conversation

dblythy
Copy link
Member

@dblythy dblythy commented May 28, 2022

Currently, it's very easy to be looking at an outdated JS DOC page without knowing.

This script checks the URL version, then gets the latest SDK version from UNPKG. If it's outdated, it adds the following div to the screen:

Screen Shot 2022-05-28 at 8 46 39 pm

To make this backwards compatible however we would need to somehow edit all the files on the github pages ENV for the JS SDK and server SDK.

@dblythy
Copy link
Member Author

dblythy commented May 28, 2022

@mtrezza let me know your thoughts

@mtrezza
Copy link
Member

mtrezza commented May 28, 2022

Is that forked template maintained at all? Maybe we just switch to a template that is more modern / maintained?
I personally never found this to be a good template, it's difficult to navigate.

How about switching to this: https://github.com/ankitskvmdam/clean-jsdoc-theme
It's maintained, has dark mode and a foldable menu, much better in my view.
And we can delete this fork, one worry less.

I've opened parse-community/parse-server#8017


Oh, I misread your suggestion - that is a nice feature indeed! But that doesn't change the fact that the template is outdated and causes a bad experience for developers.

@mtrezza mtrezza changed the title feat: check if version is latest feat: add check if version is latest May 28, 2022
@mtrezza mtrezza merged commit a893816 into parse-community:main May 28, 2022
@mtrezza
Copy link
Member

mtrezza commented May 28, 2022

I don't know how easily we can publish this package:

  • on npm it's still 1.0.0
  • here we already have 1.2.3 from 2017
  • the package.json here is still 1.0.0
  • its out of sync with the orignal repo which had commits in 2020
  • there is no CI to publish, so this has to be published to npm manually

I'm not sure we want to touch this at the moment, it looks like a pandora's box and looks like quite a process to investigate. Maybe we should rather invest the time to switch to the new template?

@dblythy
Copy link
Member Author

dblythy commented May 28, 2022

Sounds good to me!

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.

2 participants