Add documentation on how to run and build NAMD on Eiger #86
Conversation
Co-authored-by: Mikael Simberg <mikael.simberg@iki.fi>
|
The build is failing because the Eiger page isn't there. |
|
preview available: https://docs.tds.cscs.ch/86 |
Co-authored-by: Ben Cumming <bcumming@cscs.ch>
|
preview available: https://docs.tds.cscs.ch/86 |
|
preview available: https://docs.tds.cscs.ch/86 |
|
preview available: https://docs.tds.cscs.ch/86 |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
check-spelling found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.
|
There seem to be some very rudimentary support to support ignoring code blocks, but I can't see it in the release notes. See check-spelling/check-spelling#9 for a discussion. Should we try the |
Nice find! I opened #103 against this PR to try it out. It seems to indeed ignore code blocks this way (which may be too severe, but probably better this way to silence a bit more of the noise for now; code blocks are very likely to contain non-words... but also typos 🤷). Do you maybe want to quickly try it out on this PR, and we can still decide after that if we keep it or not? |
|
preview available: https://docs.tds.cscs.ch/86 |
|
preview available: https://docs.tds.cscs.ch/86 |
|
preview available: https://docs.tds.cscs.ch/86 |
|
@msimberg I added a pattern to ignore inline code blocks too. Looks like now only the actual spelling mistake in the text remains.
I totally agree that typos will remain in the code blocks, but I think this is a win for now, and we can always port unknown words from the code blocks to the |
Co-authored-by: Mikael Simberg <mikael.simberg@iki.fi>
|
preview available: https://docs.tds.cscs.ch/86 |
|
preview available: https://docs.tds.cscs.ch/86 |
| \]\[[a-z-]+\] | ||
|
|
||
| # Inline code | ||
| \`[^\`]+\` |
There was a problem hiding this comment.
Minor: perhaps this is safer:
| \`[^\`]+\` | |
| \`[^\` ]+\` |
? I'm not sure if it will otherwise exclude things in between inline code blocks as well, like
long line of `text` wiht mnay tyops `between` inline code
I think most inline code is just a single word without spaces?
msimberg
left a comment
msimberg
left a comment
There was a problem hiding this comment.
Minor question on the spell checking whitelist, but looks good to me otherwise.
Documentation update related to eth-cscs/alps-uenv#204.