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

Avoid confusing released and unreleased features in docs #1469

Open
casey opened this issue Jan 2, 2023 · 1 comment
Open

Avoid confusing released and unreleased features in docs #1469

casey opened this issue Jan 2, 2023 · 1 comment

Comments

@casey
Copy link
Owner

casey commented Jan 2, 2023

The docs in the readme and the docs at https://just.systems reflect the current master branch, not the current release, which is confusing. This came up most recently in #1467.

One possible solution is:

  • Only update the docs at just.systems on new releases, not on every change to master
  • Note at the beginning of the readme that the docs are for current mster, not the current release, and point users to the docs at just.systems for the current release documentation
@runeimp
Copy link

runeimp commented Jan 14, 2023

This falls inline with my prior suggestion of putting the version of Just that implement the feature. That way it's easy to realize to check the version of just you using when looking at a new feature to you. Maybe default to v1.0.0 for now all the pre v1.0.0 features. Then you only have to get specific since that point which hopefully isn't too much trouble.

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

No branches or pull requests

2 participants