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

Provide a clear distinction between the major version and the latest … #3514

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kacperpaczos
Copy link

…stable version of the documentation
#3513

  • Tested on all platforms changed
  • Added an entry to CHANGELOG.md if knowledge of this change could be valuable to users
  • Updated documentation to reflect any user-facing changes, including notes of platform-specific behavior
  • Created or updated an example program if it would help users understand this functionality
  • Updated feature matrix, if new features were added or implemented

@kacperpaczos
Copy link
Author

image

Copy link
Member

@kchibisov kchibisov left a comment

Choose a reason for hiding this comment

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

I'm not sure why change like that, it's already pretty clear given that one thing says docs and other says master docs.

Just moving it a bit won't do anything, so I don't see why the change needed.

@madsmtm
Copy link
Member

madsmtm commented Feb 23, 2024

See also previous discussion in #3359.

I agree that we need to do something here, I am leaning more towards putting the master docs link somewhere without a badge, or maybe prefixing it with UNSTABLE, with an orange font?

Copy link
Member

@daxpedda daxpedda left a comment

Choose a reason for hiding this comment

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

I think the badge to the stable docs should stay at the top of the README, this remains useful.

I agree that we need to do something here, I am leaning more towards putting the master docs link somewhere without a badge, or maybe prefixing it with UNSTABLE, with an orange font?

I think removing the badge to the master documentation is a good idea, expanding the ## Documentation header and adding the link there should work.

Alternatively, we could just put a warning like the one in the screenshot on top of the master docs (visible inside the documentation not in the README), which I've seen somewhere before ...

README.md Outdated Show resolved Hide resolved
Co-authored-by: daxpedda <daxpedda@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants