-
Notifications
You must be signed in to change notification settings - Fork 6
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
Landing: day to day usage #307
base: main
Are you sure you want to change the base?
Conversation
Example of "How to use Read the Docs in your daily work" after reading the onboarding book on Book Club. The idea of this page is to show _exactly_ how customers will use Read the Docs on their day to day work to make them reach that "aha" moment when they realize this workflow is a lot easier than the one they are currently following. Goals: - explain how they will use Read the Docs daily - mention docs as code workflow - explain write, push, review and deploy stages - show images representing those exact stages - mention we don't provide an editor Page based on https://about.readthedocs.com/docs-as-code/ structure.
b67eccd
to
185a560
Compare
This feels like great content. Where do you think it fits into the content? As a "fifth" piece of content along with the 4 steps we have now in the top nav, and replacing the "How RTD works" page? |
I wouldn't start replacing any content with this page. I think it's not a 1:1 replacement of anything we already have. Also, the page that I've created is not perfect and it will require more iterations for sure. I'm currently thinking this page as a complement of "How Read the Docs works?", so we can link it from there with something like "How does it look my day to day with Read the Docs?" or similar. However, clicking on "How Read the Docs works?" goes to By the way, that With that in mind, it may make sense to expose that page as "All features" and the new page as "Usage" to the dropdown. A suggestion to explore:
Keep in mind that in the current Product dropdown, "Building" and "Hosting" features point to the same |
This sounds like a good plan to me. I do worry we're kind of repeating the same concepts, but I agree Workflow/Usage is a bit different than Features, and it's useful to have both. We've been combining them together in the past, which maybe is overloading things a bit much? I thought @agjohnson had a revamp of the building or hosting page at one point, but I don't see a PR with it, so not sure. |
The current page at I do think we should have features listed by category -- build/hosting/etc -- but would like to see Breaking up the current I started one of the sections in book club, but this is probably the wrong venue for a change like that. |
Example of "How to use Read the Docs in your daily work" after reading the onboarding book on Book Club.
The idea of this page is to show exactly how customers will use Read the Docs on their day to day work to make them reach that "aha" moment when they realize this workflow is a lot easier than the one they are currently following.
Goals:
Page based on https://about.readthedocs.com/docs-as-code/ structure.
ToDo
📚 Documentation preview 📚: https://readthedocs-about--307.org.readthedocs.build/usage/