Merged
Conversation
orlandohohmeier
requested review from
l45k and
nfnt
and removed request for
l45k
nfnt
previously approved these changes
Nov 12, 2025
Contributor
nfnt
left a comment
nfnt
left a comment
There was a problem hiding this comment.
LGTM! CI is failing though, seems to be caused by a doc test.
Contributor
Author
|
Dang, yes forgot to add a don't run as that isn't actually a test. |
Rephrased _every_ command’s `about`/`long_about` text using `indoc!`, so multi-line help renders cleanly and actually explains the scheduler, gateway, worker, and cert utilities. The config modules now describe required fields (like gateway `external_addresses`) and defaults inline, giving users immediate context instead of chasing the handbook. Co-Authored-By: ChatGPT <openai@users.noreply.github.com>
Gateway now calls `Config::validate()` right after loading settings, so misconfigured nodes (e.g., missing `external_addresses`) fail fast with a targeted error instead of hanging silently. This keeps users from deploying unusable gateways and makes troubleshooting much clearer.
orlandohohmeier
force-pushed
the
orlandohohmeier/improve-cli-ux
branch
from
ba06716 to
7e6fbb8
Compare
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
l45k
reviewed
Nov 13, 2025
Comment on lines
+91
to
+93
| /// slice-0000.bin | ||
| /// slice-0001.bin | ||
| /// slice-0002.bin |
l45k
reviewed
Nov 13, 2025
| with code 0 if the peer is healthy, or non-zero otherwise. | ||
|
|
||
| Useful for: | ||
| * Container health checks (Docker, Kubernetes) |
l45k
reviewed
Nov 13, 2025
|
|
||
| Useful for: | ||
| * Verifying gateway connectivity before starting jobs | ||
| * Container health checks (Docker, Kubernetes) |
l45k
reviewed
Nov 13, 2025
|
|
||
| Useful for: | ||
| * Verifying gateway connectivity before starting jobs | ||
| * Container health checks (Docker, Kubernetes) |
l45k
approved these changes
Nov 13, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This PR rewrite the CLI help and config docs and make sure the gateway config is validated before, to generally improve the user experience.