docs(readme): add the Slack CLI logo to the README.md #9
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| # Project build files | ||
| bin/ | ||
| slack | ||
| slack-cli | ||
| hermes | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,6 +26,7 @@ header: | |
| - '**/*.json' | ||
| - '**/*.md' | ||
| - '**/*.tmpl' | ||
| - '**/*.svg' | ||
| - 'dotgitignore' | ||
| - 'go.sum' | ||
| - 'go.mod' | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,4 +1,4 @@ | ||||||
| # Slack CLI <img src="docs/static/img/slack-cli-logo.svg" alt="Slack CLI logo" style="height: 1em; max-width: 100%" /> | ||||||
|
Contributor
There was a problem hiding this comment. Just personnel preference but also sharing some of my past explorations, the title can be centered by using html tags as well, bolt-python, python-sdk, python-hooks)
Suggested change
Member
Author
There was a problem hiding this comment. The center alignment is a nice touch of the Python projects! 👌🏻 I've tried it with this README.md and it doesn't look quite as slick. Below, I've centered the title, status badges, and quote description. What are your thoughts on this style @WilliamBergamin @lukegalbraithrussell? My gut says all 3 should be centered otherwise none. The quote description looks funny, but it looks better if I switch it to italics. Centered Title: 
Centered Title & Status: 
Centered Title, Status, and Description: 
Centered Title, Status, and Description (Italics): 
Member
There was a problem hiding this comment. 📝 Adding onto this to prefer using https://github.com/artempyanykh/marksman/blob/main/docs/features.md#titles-from-headings
Member
There was a problem hiding this comment. If this is centered, I think the last option is best with perhaps swapped lines for the status and description? I'm not sure of the markup needed for this though.
Member
Author
There was a problem hiding this comment. @zimeg Thanks for sharing those links! 🙇🏻 Since using HTML can lead to parsing problems for some readers AND popular Golang projects use standard markdown, let's align with the Golang community and continue to use a I think we could consider adding a header image that uses the Slack CLI Logo and text, to follow in the foot steps of other popular Golang projects: |
||||||
|
|
||||||
| [](https://github.com/slackapi/slack-cli/actions/workflows/tests.yml) | ||||||
| [](https://codecov.io/gh/slackapi/slack-cli) | ||||||
|
|
||||||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing this makes sense to me with the other documentation changes in progress! IIRC additional written pages - not autogen - might soon find this path.
We might want to consider either committing the autogen files or ignoring these here though. I lean towards ignoring since the build process for docs uses this command itself! Otherwise, we might want to fail CI if these files don't match whats expected...
No blocker for this PR though! These files are find to keep unstaged after
docgenfor now 📚 ✨There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that we may want to change the default path for
docgenand/or.gitignorethe files.Since
docgenis a hidden command, I think we can safely change the default directory with apatchorminor. Let's hold off until we move the public docs over, then we can decide what makes the most sense!