docs(readme): add the Slack CLI logo to the README.md #9
Conversation
mwbrooks
added
docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
license-eye has checked 503 files.
| Valid | Invalid | Ignored | Fixed |
|---|---|---|---|
| 460 | 1 | 42 | 0 |
Click to see the invalid file list
- docs/static/img/slack-cli-logo.svg
Use this command to fix any missing license headers
```bash
docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix
</details>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9 +/- ##
=======================================
Coverage 62.80% 62.80%
=======================================
Files 210 210
Lines 22053 22053
=======================================
+ Hits 13850 13851 +1
+ Misses 7126 7125 -1
Partials 1077 1077 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
WilliamBergamin
left a comment
WilliamBergamin
left a comment
There was a problem hiding this comment.
Sweet 💯
Attention to detail makes this project feel Slacky
| @@ -1,4 +1,4 @@ | |||
| # Slack CLI | |||
| # Slack CLI <img src="docs/static/img/slack-cli-logo.svg" alt="Slack CLI logo" style="height: 1em; max-width: 100%" /> | |||
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)
| # Slack CLI <img src="docs/static/img/slack-cli-logo.svg" alt="Slack CLI logo" style="height: 1em; max-width: 100%" /> | |
| <h1 align="center">Slack CLI <img src="docs/static/img/slack-cli-logo.svg" alt="Slack CLI logo" style="height: 1em; max-width: 100%" /></h1> |
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):
There was a problem hiding this comment.
📝 Adding onto this to prefer using # for title headings and following sections for standard parsings that some readers might use:
https://github.com/artempyanykh/marksman/blob/main/docs/features.md#titles-from-headings
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.
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:
lukegalbraithrussell
left a comment
lukegalbraithrussell
left a comment
There was a problem hiding this comment.
+1 to william's small suggestion on centering the image
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
LGTM! And I too am a fan of bringing a splash to this document 🎁
Do you notice that the logo is offset vertically a little bit?
@mwbrooks Incredible eye! I use Safari but to me this offset is within reasonable doubt:
Overall I'd lean toward not handling special cases in this formatting since this might not render as expected elsewhere. While I expected images to align, this might be something that's even changed later within the browser!
The discussion around centering the header and details is also something I'm interested in, but I notice other go projects do not follow that convention:
- https://github.com/spf13/cobra?tab=readme-ov-file
- https://github.com/charmbracelet/lipgloss?tab=readme-ov-file
And aligning to this seems best to me, but no blocker.
The care for this page is so much appreciated overall 👾 ✨
| @@ -1,4 +1,4 @@ | |||
| # Slack CLI | |||
| # Slack CLI <img src="docs/static/img/slack-cli-logo.svg" alt="Slack CLI logo" style="height: 1em; max-width: 100%" /> | |||
There was a problem hiding this comment.
📝 Adding onto this to prefer using # for title headings and following sections for standard parsings that some readers might use:
https://github.com/artempyanykh/marksman/blob/main/docs/features.md#titles-from-headings
| @@ -1,4 +1,4 @@ | |||
| # Slack CLI | |||
| # Slack CLI <img src="docs/static/img/slack-cli-logo.svg" alt="Slack CLI logo" style="height: 1em; max-width: 100%" /> | |||
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.
| @@ -1,6 +1,5 @@ | |||
| # Project build files | |||
| bin/ | |||
| docs/ | |||
There was a problem hiding this comment.
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 docgen for now 📚 ✨
There was a problem hiding this comment.
I agree that we may want to change the default path for docgen and/or .gitignore the files.
Since docgen is a hidden command, I think we can safely change the default directory with a patch or minor. Let's hold off until we move the public docs over, then we can decide what makes the most sense!
📝 Huh this happened sooner than I had guessed... https://developer.mozilla.org/en-US/blog/h1-element-styles/
|
So cool to see the default UA styles for online text changing before our eyes! Let's keep an eye on our README.md to make sure it continues to look sharp ✨ |
Summary
This pull request adds the Slack CLI logo to the title of the README.md file to match slackapi/bolt-js and slackapi/bolt-python.
Reviewers
.gitignoreto no longer ignore thedocs/*docs/*because the commanddocgenusesdocs/as the default directorydocs/directory as wellmargin-bottom: -0.1em;then it fixes it on my system, but this could be different on each systemRequirements