Skip to content
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

Merged
merged 23 commits into from
Apr 3, 2022

Conversation

jtoar
Copy link
Contributor

@jtoar jtoar commented Apr 2, 2022

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.

@jtoar jtoar self-assigned this Apr 2, 2022
@netlify
Copy link

netlify bot commented Apr 2, 2022

Deploy Preview for redwoodjs-docs ready!

Name Link
🔨 Latest commit f08b9e6
🔍 Latest deploy log https://app.netlify.com/sites/redwoodjs-docs/deploys/62494cba2603a300082a0110
😎 Deploy Preview https://deploy-preview-4993--redwoodjs-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@jtoar jtoar marked this pull request as ready for review April 2, 2022 16:45
@thedavidprice
Copy link
Contributor

Other items to update:

  • click on Docs should go to docs/introduction
  • click on Logo should go to https://redwoodjs.com/

And some thoughts about improvements to the mobile view (not everything is working):

GoogleChrome-2Apr22_18-06-49.mp4

@jtoar
Copy link
Contributor Author

jtoar commented Apr 3, 2022

@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.

@jtoar jtoar added topic/docs topic/crwa create-redwood-app release:feature This PR introduces a new feature labels Apr 3, 2022
@jtoar jtoar merged commit d4a430a into main Apr 3, 2022
@jtoar jtoar deleted the ds-reorganize-sidebar,add-intro branch April 3, 2022 07:29
@jtoar jtoar added this to the next-release milestone Apr 3, 2022
@thedavidprice
Copy link
Contributor

Hellofa job well done here @jtoar Looking really really solid all around.

Information Architecture
I like that the docs/ link from the home page goes to docs/introduction. But if you manually enter rwjs.com/doc it goes to docs/index Now that I think about that, its probably the right UX.

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 deploy/introduction to have links to the sections in the Right Sidebar, but it doesn't. And although I'm so used to this Doc, I even got lured into cliking on the links to the Provider websites that I intuitively thought were for sections... (I'm going to change that right. now. And will do the same for Auth.)

Including in Final 1.0.0
To include the new CRWA README in the 1.0.0 relase, I'm adding this next-release-patch milestone.

@jtoar jtoar mentioned this pull request Apr 3, 2022
thedavidprice added a commit that referenced this pull request Apr 4, 2022
* 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]>
@thedavidprice thedavidprice modified the milestones: next-release, v1.1.0 Apr 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:feature This PR introduces a new feature topic/crwa create-redwood-app topic/docs
Projects
No open projects
Status: Archived
Development

Successfully merging this pull request may close these issues.

3 participants