Skip to content

Prune unpolished and extra pages in online docs#79

Merged
kvrigor merged 25 commits intomasterfrom
docs-polish-instructions
Apr 15, 2026
Merged

Prune unpolished and extra pages in online docs#79
kvrigor merged 25 commits intomasterfrom
docs-polish-instructions

Conversation

@kvrigor
Copy link
Copy Markdown
Member

@kvrigor kvrigor commented Oct 10, 2025

TODO. This PR must meet the JOSS documentation review criteria:

UPDATE 12.01.26: Aiming to tick all JOSS review criteria in a single PR would be too much (as @jjokella rightly suggests). I'll limit the scope of this PR on having a polished eCLM guide that only requires an Ubuntu system.. Such guide would be helpful for interested users who don't have access to any HPC cluster.

@kvrigor kvrigor self-assigned this Oct 10, 2025
@AGonzalezNicolas AGonzalezNicolas marked this pull request as ready for review October 10, 2025 08:44
@kvrigor kvrigor marked this pull request as draft October 10, 2025 08:58
@kvrigor kvrigor linked an issue Oct 10, 2025 that may be closed by this pull request
@kvrigor kvrigor changed the title Update docs to meet JOSS review criteria Docs: Introduce HPC-agnostic eCLM setup guide Jan 12, 2026
@kvrigor kvrigor changed the title Docs: Introduce HPC-agnostic eCLM setup guide Minimum changes to meet JOSS docs criteria Mar 10, 2026
@kvrigor kvrigor requested a review from jjokella March 18, 2026 06:15
@kvrigor kvrigor marked this pull request as ready for review March 18, 2026 06:15
@kvrigor kvrigor changed the title Minimum changes to meet JOSS docs criteria Prune unpolished and extra pages in online docs Mar 18, 2026
@jjokella
Copy link
Copy Markdown
Contributor

Minor comments:

  • "Running example cases" Could be filled with a small introductory text
  • "Creating a custom case": Could be made a page in this doc and then small text and link inside!? At least for me it was slightly confusing to notice that I am in a different document because they look so similar^^

Comment thread docs/INDEX.md
@jjokella
Copy link
Copy Markdown
Contributor

All-in-all, I approve this PR - then we can always discuss some additional doc topics in dedicated PRs.

@kvrigor kvrigor merged commit 5f0b6b0 into master Apr 15, 2026
8 checks passed
@kvrigor kvrigor deleted the docs-polish-instructions branch April 28, 2026 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Detailed Description of eCLM

3 participants