Skip to content

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

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
merged 1 commit into from
Apr 3, 2025
Merged

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

merged 1 commit into from
Apr 3, 2025

Conversation

slackapi[bot]
Copy link
Contributor

@slackapi slackapi bot commented Apr 2, 2025 •
edited by lukegalbraithrussell
Loading

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

@lukegalbraithrussell lukegalbraithrussell changed the title Chore: tweaks sync workflow Feat: adds docs Apr 2, 2025
@zimeg zimeg mentioned this pull request Apr 3, 2025
Merged
2 tasks
@codecov Codecov
Copy link

codecov bot commented Apr 3, 2025 •
edited
Loading

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 zimeg changed the title Feat: adds docs feat: organize documentation as markdown files to match web pages Apr 3, 2025
@zimeg zimeg added the docs Improvements or additions to documentation label Apr 3, 2025
@zimeg 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
zimeg approved these changes Apr 3, 2025
View reviewed changes
Copy link
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

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 👾

@lukegalbraithrussell
Copy link
Contributor

I'll follow up with a readme PR!

@lukegalbraithrussell lukegalbraithrussell merged commit 18d0229 into main Apr 3, 2025
7 checks passed
@lukegalbraithrussell lukegalbraithrussell deleted the docs-automated-sync-pr-103 branch April 3, 2025 17:28
@alma-renovate-bot alma-renovate-bot bot mentioned this pull request Jun 26, 2025
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zimeg zimeg zimeg approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lukegalbraithrussell @zimeg
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy