[JOSS REVIEW] Small doc suggestions

lanl / spiner

Performance portable routines for generic, tabulated, multi-dimensional data

https://lanl.github.io/spiner

BSD 3-Clause "New" or "Revised" License

7 stars 3 forks source link

[JOSS REVIEW] Small doc suggestions #30

Closed lgarrison closed 2 years ago

lgarrison commented 2 years ago

PR Summary

I ran into some problems following the installation instructions in the docs while working on the JOSS review, so I tweaked them to reflect the intention (I think). I'm also not a CMake expert, so feel free to correct my suggestions!

I also added a section heading called "Contributing" before the text describing how to contribute; it can be useful to denote a section that can be continually expanded, and that has a link to point users to.

PR Checklist

[x] Code is formatted.

lgarrison commented 2 years ago

I'll add that once I got the installation working, the tests worked perfectly!

Yurlungur commented 2 years ago

Thanks for these fixes! (The doc build stage succeeded, though the deploy stage failed. That's fine, since you don't have push permissions to the pages repo.)