Add clear reminder to check known issues with CP2K #208
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
preview available: https://docs.tds.cscs.ch/208 |
RMeli
reviewed
Jul 22, 2025
docs/software/sciapps/cp2k.md
Outdated
| [CP2K] is provided on [ALPS][platforms-on-alps] via [uenv][ref-uenv]. | ||
| Please have a look at the [uenv documentation][ref-uenv] for more information about uenvs and how to use them. | ||
|
|
||
| !!! note "Known issues" |
Member
There was a problem hiding this comment.
A "note" doesn't stand out much IMO. I'd use a "tip" to differentiate it, or even something stronger like "warning" or even "bug". What do you think?
Collaborator
Author
There was a problem hiding this comment.
Good point. I think "warning" should do it.
|
preview available: https://docs.tds.cscs.ch/208 |
RMeli
approved these changes
Jul 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have a strong feeling that many users do not read the full CP2K documentation and miss the important
Known issuessection. This leads to sub-optimal runs and waste of resources. This should hopefully help.