Skip to content

docs: tweaks formatting to match rest of docs #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
lukegalbraithrussell merged 3 commits into from
Jul 11, 2025
Merged

docs: tweaks formatting to match rest of docs #150

lukegalbraithrussell merged 3 commits into from
Jul 11, 2025

Conversation

@lukegalbraithrussell
Copy link
Contributor

@lukegalbraithrussell lukegalbraithrussell commented Jul 9, 2025 •
edited
Loading

Summary

  • Gave titles to all admonitions
  • Cleaned up some old html syntax that should be markdown
  • Fixed some broken links
  • Removed 80-character line breaks for markdown

Requirements

@lukegalbraithrussell lukegalbraithrussell requested a review from a team as a code owner July 9, 2025 15:33
lukegalbraithrussell
lukegalbraithrussell commented Jul 9, 2025
View reviewed changes
docs/guides/installing-the-slack-cli-for-mac-and-linux.md
🍎 ⚡️ [**Download for macOS Apple Silicon (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_arm64.tar.gz)

<ts-icon class="ts_icon_apple"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_amd64.tar.gz"><strong>Download for macOS Intel (.tar.gz)</strong></a>
🍏 🪨 [**Download for macOS Intel (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_amd64.tar.gz)
Copy link
Contributor Author

@lukegalbraithrussell lukegalbraithrussell Jul 9, 2025

Choose a reason for hiding this comment

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

stone because rosetta, get itttttt

Copy link
Member

@mwbrooks mwbrooks Jul 9, 2025

Choose a reason for hiding this comment

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

😄 And the green apple 🍏

Copy link
Member

@mwbrooks mwbrooks Jul 9, 2025

Choose a reason for hiding this comment

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

We could upload macOS, Windows, and Linux icons as well.

@codecov
Copy link

codecov bot commented Jul 9, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.35%. Comparing base (e5b2dd0) to head (d4848a3).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #150      +/-   ##
==========================================
- Coverage   63.35%   63.35%   -0.01%     
==========================================
  Files         212      212              
  Lines       22333    22333              
==========================================
- Hits        14150    14149       -1     
- Misses       7094     7097       +3     
+ Partials     1089     1087       -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mwbrooks mwbrooks changed the title Docs: tweaks formatting to match rest of docs docs: tweaks formatting to match rest of docs Jul 9, 2025
@mwbrooks mwbrooks added docs M-T: Documentation work only semver:patch Use on pull requests to describe the release version increment labels Jul 9, 2025
@mwbrooks mwbrooks added this to the Next Release milestone Jul 9, 2025
mwbrooks
mwbrooks approved these changes Jul 9, 2025
View reviewed changes
Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

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

✅ Looking solid @lukegalbraithrussell!

🙇🏻 Thanks for tightening up the docs and we can try to avoid the 80 character limit breaks, if that's a style that you want to avoid in the docs.

💡 Left a minor idea around Deno SDK Installation but it's not something that should be done in this PR. Merge away!

docs/guides/installing-the-slack-cli-for-mac-and-linux.md
🍎 ⚡️ [**Download for macOS Apple Silicon (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_arm64.tar.gz)

<ts-icon class="ts_icon_apple"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_amd64.tar.gz"><strong>Download for macOS Intel (.tar.gz)</strong></a>
🍏 🪨 [**Download for macOS Intel (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_amd64.tar.gz)
Copy link
Member

@mwbrooks mwbrooks Jul 9, 2025

Choose a reason for hiding this comment

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

😄 And the green apple 🍏

docs/guides/installing-the-slack-cli-for-mac-and-linux.md
🍎 ⚡️ [**Download for macOS Apple Silicon (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_arm64.tar.gz)

<ts-icon class="ts_icon_apple"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_amd64.tar.gz"><strong>Download for macOS Intel (.tar.gz)</strong></a>
🍏 🪨 [**Download for macOS Intel (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_amd64.tar.gz)
Copy link
Member

@mwbrooks mwbrooks Jul 9, 2025

Choose a reason for hiding this comment

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

We could upload macOS, Windows, and Linux icons as well.

docs/guides/installing-the-slack-cli-for-mac-and-linux.md

**8\. [Install the VSCode extension for
Deno](/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**
**8\. [Install the VSCode extension for Deno](/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**
Copy link
Member

@mwbrooks mwbrooks Jul 9, 2025

Choose a reason for hiding this comment

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

question: Soon, it may make sense to have the Deno install instructions on the Deno SDK page and link to it (and Bolt JS/Python) from here.

@lukegalbraithrussell lukegalbraithrussell merged commit 79cacce into main Jul 11, 2025
6 checks passed
@lukegalbraithrussell lukegalbraithrussell deleted the docs-formatting-cleanup branch July 11, 2025 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mwbrooks mwbrooks mwbrooks approved these changes

@haleychaas haleychaas haleychaas approved these changes

Assignees

@lukegalbraithrussell lukegalbraithrussell

Labels

docs M-T: Documentation work only semver:patch Use on pull requests to describe the release version increment

Projects

None yet

Milestone

v3.5.1

Development

Successfully merging this pull request may close these issues.

4 participants

@lukegalbraithrussell @mwbrooks @haleychaas