Skip to content
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

API reference is out of sync with NPM package #60

Open
pvditto opened this issue May 21, 2024 · 0 comments
Open

API reference is out of sync with NPM package #60

pvditto opened this issue May 21, 2024 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@pvditto
Copy link
Contributor

pvditto commented May 21, 2024

Users who look for the library's documentation will come across the rendered docs linked from this repo at https://getditto.github.io/react-ditto/. However, these docs reflect the state of the master branch, which currently is out of sync with the latest published release.

Possible solutions could be:

  • only publishing documentation when also publishing an NPM release (probably easiest to implement)
  • publishing documentation for releases to named subdirectories, e.g. https://getditto.github.io/react-ditto/v11.0 and redirecting from the GH docs root to the latest version's page. (nice because older docs versions are kept online)
@pvditto pvditto added bug Something isn't working documentation Improvements or additions to documentation labels May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant