-
Notifications
You must be signed in to change notification settings - Fork 296
docs: cleanup docs #4434
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.
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
docs: cleanup docs #4434
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4434 +/- ##
==========================================
+ Coverage 77.66% 77.71% +0.04%
==========================================
Files 843 844 +1
Lines 112186 112601 +415
==========================================
+ Hits 87128 87505 +377
- Misses 25058 25096 +38 🚀 New features to boost your workflow:
|
b5aa73a
to
0d38cd0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some small things, mostly on using the term "engine" instead of "tool"
Most commonly you will be creating expressions by using the [`daft.col()`][daft.expressions.col] function. The following example will create an expressiom referring to a columned named `A` but with every row incremented by 1. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hi, super nit but I just saw these typos as I was reading through the docs myself. "expressiom" -> "expression" and "columned" -> "column"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call out! @ccmao1130, can you make a PR to fix some of these typos
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes! Will make the changes in #4488
## Changes Made File paths for integrations are currently `integrations/...` when they should be in their respective folder `io/...` and `catalogs/...`, moved files accordingly Added redirects from `integrations/...` to `io/...` and `catalogs/...` Added an Integrations Overview page that will link to pages in their respective folders Added `↗` to all external links and all external links open in new tab Typos called out in #4434 See build: https://docs.getdaft.io/en/chanchan-docs-integrations/ ## Related Issues #4313 ## Checklist - [ ] Documented in API Docs (if applicable) - [x] Documented in User Guide (if applicable) - [ ] If adding a new documentation page, doc is added to `docs/mkdocs.yml` navigation - [ ] Documentation builds and is formatted properly (tag @/ccmao1130 for docs review)
Changes Made
See build here: https://www.getdaft.io/projects/docs/en/chanchan-docs-cleanup/ (logo in favicon will update once merged to main)
Checklist
docs/mkdocs.yml
navigation