-
Notifications
You must be signed in to change notification settings - Fork 133
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: "user guide" section cleanup #826
Conversation
Renamed the section from "How To Guides" to "User Guide". Changed the title of "User Guide" pages to be easier to visually scan. Essentially, this consists of shorter titles with the most important word at the beginning
To me the purpose of the So I think the changes mostly look good. Left comments where appropriate. |
I agree on the purpose of the "how-to" / "user guide" section. I believe "User guide" pages should mirror frequent Q/A on Slack. Pages on "Feature engineering", "pre-commit", "jupyter notebooks" are good examples. Many of the current pages are too introductory / generic. In that case, it should be reframed to be part of the "Concepts" section (e.g., "Load data" doesn't add much compared to the materialization page). |
Changes
Before:
After:
How I tested this
Notes
Checklist