FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: organize documentation as markdown files to match web pages by slackapi[bot] · Pull Request #422 · slackapi/slack-github-action · GitHub

docs: organize documentation as markdown files to match web pages - #422

Merged
lukegalbraithrussell merged 1 commit into
mainfrom
docs-automated-sync-pr-103
Apr 3, 2025
Merged

docs: organize documentation as markdown files to match web pages#422
lukegalbraithrussell merged 1 commit into
mainfrom
docs-automated-sync-pr-103

Conversation

slackapi Bot commented Apr 2, 2025
edited by lukegalbraithrussell
Loading

Copy link
Copy Markdown
Contributor

This PR adds markdown docs to the slack github action repo, synced with the tools.slack.dev repo

lukegalbraithrussell changed the title Chore: tweaks sync workflow Feat: adds docs Apr 2, 2025

codecov Bot commented Apr 3, 2025
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.85%. Comparing base (79ad3a9) to head (0c9e411).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #422   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files           7        7           
  Lines         702      702           
=======================================
  Hits          701      701           
  Misses          1        1           

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

zimeg changed the title Feat: adds docs feat: organize documentation as markdown files to match web pages Apr 3, 2025
zimeg added the docs Improvements or additions to documentation label Apr 3, 2025
zimeg changed the title feat: organize documentation as markdown files to match web pages docs: organize documentation as markdown files to match web pages Apr 3, 2025

zimeg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM! All of these files seem to match what's published now, so no changes suggested 🎉

I am curious if we want to revisit the README.md before or soon after merging this though 👀

While it's not so much trouble to keep both of these pages updated, I'm leaning towards detail in the docs directories and a perhaps somewhat plain overviews of the techniques in the README.md?

We've put solid efforts into organizing information in the README.md, but I imagine the web pages have more room for detail! I'm most excited for the descriptions now possible with examples 👾

Copy link
Copy Markdown
Contributor

I'll follow up with a readme PR!

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

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants


Back | FazBrowse Home | New Git URL