-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Rename Cookbook to How To, add Introduction, update Quick Start #4993
Conversation
✅ Deploy Preview for redwoodjs-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Other items to update:
And some thoughts about improvements to the mobile view (not everything is working): GoogleChrome-2Apr22_18-06-49.mp4 |
@thedavidprice Just watched the video; agree with everything! Wanted to point out one thing about the Deployment breadcrumb link: the reason that doesn't work is there's no deployment index page: https://redwoodjs.com/docs/deploy/index. The reference one works because there is a reference index page: https://redwoodjs.com/docs/index. We could maybe make the breadcrumb link just go to the introduction: https://redwoodjs.com/docs/deploy/introduction. |
Hellofa job well done here @jtoar Looking really really solid all around. Information Architecture I suggest EVERY top-level category — e.g. Reference, Deployment, etc. — needs an index page. Several times now I've tried to move between the sections for Deploy providers on smaller screens and the UX is effectively broken. I expected the Including in Final 1.0.0 |
* rename cookbook to how to, add intro, update quick start * quick start edits * quick start edits * update crwa readme * contrib overview updates * update intro * update intro * add hyphen * rm last line * update yarn links * Update docs/docs/introduction.md Co-authored-by: David Price <[email protected]> * update intro * start quick links section * quick start: add bit on CLI * add storybook section * stub sections on deploy, auth * tweak intro * tweak quick start * add section on jest * update links, update readme * updates * final edits Co-authored-by: David Price <[email protected]>
This PR reorganizes the sidebar so that the doc categories reflect a kind of learning path. In the process, a new doc, Introduction is added (still a bit of a work in progress), the Quick Start is updated, and Cookbook is renamed to How To (corresponding redwoodjs.com update https://github.com/redwoodjs/redwoodjs.com/pull/1017).
Once the intro and quick start are closer to being finished, I'll update the crwa README.md as well.