docs: organize documentation as markdown files to match web pages#422
docs: organize documentation as markdown files to match web pages#422lukegalbraithrussell merged 1 commit intomainfrom
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. 🚀 New features to boost your workflow:
|
zimeg
left a comment
There was a problem hiding this comment.
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 👾
|
I'll follow up with a readme PR! |
This PR adds markdown docs to the slack github action repo, synced with the tools.slack.dev repo