Skip to content

revise README.md and app.cfg.example#325

Merged
Neves-P merged 12 commits into
EESSI:developfrom
trz42:update_readme_app_cfg_example
Jun 28, 2025
Merged

revise README.md and app.cfg.example#325
Neves-P merged 12 commits into
EESSI:developfrom
trz42:update_readme_app_cfg_example

Conversation

@trz42
Copy link
Copy Markdown
Contributor

@trz42 trz42 commented Jun 23, 2025

PR looks large, but it contains mostly polishing changes and updates that were missing in previous PRs/releases.

  • Updates both README.md and app.cfg.example so they include all current configuration settings.
  • Also improves several sections of README.md (cleaning up old stuff, pointing to new EESSI-built container for the Smee client, etc.)
  • Adds markdown linting CI for README.md

@trz42 trz42 added docs Improvements or additions to documentation enhancement bug labels Jun 23, 2025
@trz42 trz42 marked this pull request as ready for review June 26, 2025 08:44
Copy link
Copy Markdown
Member

@Neves-P Neves-P left a comment

Choose a reason for hiding this comment

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

Nice, this PR definitely makes the whole setup clearer!

I reworded or expanded a few points, but nothing major. Feel free to reject or modify the suggestions further if you feel like they are not relevant or could be better.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread app.cfg.example Outdated
Comment thread app.cfg.example Outdated
Comment thread app.cfg.example
trz42 and others added 2 commits June 27, 2025 21:12
Co-authored-by: Pedro Santos Neves <10762799+Neves-P@users.noreply.github.com>
Copy link
Copy Markdown
Member

@Neves-P Neves-P left a comment

Choose a reason for hiding this comment

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

Thanks for the changes @trz42

Looks great!

Keep linter happy
@Neves-P
Copy link
Copy Markdown
Member

Neves-P commented Jun 28, 2025

Pushed a very small commit to keep the (great new!) linter happy. The checks pass, so I'll go ahead and merge this 👍

@Neves-P Neves-P merged commit 5065c16 into EESSI:develop Jun 28, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug docs Improvements or additions to documentation enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants