README.md: Iterate on UX, pkg/cli: add colors, improve help text#97
Merged
Conversation
sam-heilbron
force-pushed
the
sh/ux-improvements
branch
2 times, most recently
from
6027af1 to
8b2fd48
Compare
peterj
reviewed
Nov 5, 2025
peterj
reviewed
Nov 5, 2025
peterj
reviewed
Nov 5, 2025
| - Configures and deploys a Transport Adapter as a sidecar or separate service | ||
| - Sets up networking and ingress rules | ||
| - Manages secrets and environment variables | ||
| - [Your first MCP service prototype](/devel/quickstart/first-prototype.md) |
Contributor
There was a problem hiding this comment.
would these be better in the docs?
Contributor
Author
There was a problem hiding this comment.
yeah my thinking was that it woudl be faster to iterate here, but ideally would be in docs. i opened that docs repo and looks pretty easy to contirbute to, so i intend to link to docs instead.
Contributor
Author
There was a problem hiding this comment.
I updated to point to the existing docs. I think there are more quickstarts we could add, but it won't be done as part of this PR.
Signed-off-by: Sam Heilbron <samheilbron@gmail.com>
Signed-off-by: Sam Heilbron <samheilbron@gmail.com>
Signed-off-by: Sam Heilbron <samheilbron@gmail.com> rename hook Signed-off-by: Sam Heilbron <samheilbron@gmail.com> executable Signed-off-by: Sam Heilbron <samheilbron@gmail.com>
Co-authored-by: Peter Jausovec <peterj@users.noreply.github.com> Signed-off-by: Sam Heilbron <SamHeilbron@gmail.com> Signed-off-by: Sam Heilbron <samheilbron@gmail.com>
Co-authored-by: Peter Jausovec <peterj@users.noreply.github.com> Signed-off-by: Sam Heilbron <SamHeilbron@gmail.com> Signed-off-by: Sam Heilbron <samheilbron@gmail.com>
sam-heilbron
force-pushed
the
sh/ux-improvements
branch
from
4d105be to
da19f3f
Compare
Signed-off-by: Sam Heilbron <samheilbron@gmail.com> first prototype Signed-off-by: Sam Heilbron <samheilbron@gmail.com> quickstart link to docs Signed-off-by: Sam Heilbron <samheilbron@gmail.com> readme footer cleanup Signed-off-by: Sam Heilbron <samheilbron@gmail.com>
Co-authored-by: Peter Jausovec <peterj@users.noreply.github.com> Signed-off-by: Sam Heilbron <SamHeilbron@gmail.com> Signed-off-by: Sam Heilbron <samheilbron@gmail.com>
Signed-off-by: Sam Heilbron <samheilbron@gmail.com>
sam-heilbron
force-pushed
the
sh/ux-improvements
branch
from
da19f3f to
c9ebbf1
Compare
Signed-off-by: Sam Heilbron <samheilbron@gmail.com>
nikolasmatt
approved these changes
Nov 6, 2025
| return kmcpLogoAscii | ||
| } | ||
|
|
||
| func ColoredKmcpLogo() string { |
There was a problem hiding this comment.
nit: since this isn't in a dedicated package, i recommend putting the qualifier in the end for consistency
KmcpLogo()
KmcpLogoColored()
Contributor
Author
There was a problem hiding this comment.
I like it! Ill likely handle this in a follow
peterj
approved these changes
Nov 6, 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.
Description
Propose a change to the landing page of the project to make it more user friendly
Context
README
Changes are fairly self-explanatory. I'm certainly open to feedback on the structure or syntax. The goal was to approach this with a more "show -over- tell". So instead of telling people what the value is of the project, show how they can access it. For the most part, this content existed before.
devel/ folder
There was some really useful content in the top level README, but I felt that it kind of diluted the message in that readme. My proposal here is to take the content and move it to a dedicated area, and link to it from the README
CLI
The CLI now has some color, and an improved help text.
For posterity, I used https://carbon.now.sh to generate the image in the README representing the CLI