-
Notifications
You must be signed in to change notification settings - Fork 146
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: Add getting started section on the home page of doc #392
Comments
See also #385 for examples |
In #1133 we have updated the format/ordering of sections of the homepage. Readers now have more actionable items on top: how to install, how to use with popular framework, link to examples, env variable, and finally tenets. I'll be closing this issue for the time being, but in case anyone lands here because they find the docs unclear please open a new issue to discuss additional changes. |
|
Description of the improvement
Summary of the proposal
As a user, I want to see “Getting started” first. I am not interested in Tenets so I find it not so user friendly to have that as the first section when I see the doc. I have to jump to Installation (and then go to individual core utility page) to get start.
I propose having this as the first section in the home page. It should have accompanied code for running in an actual environment (e.g. cookie cutter project in #391 ). It should support popular tools like:
examples/cdk
folder)How, where did you look for information
examples/cdk
folder. This is not explicitly linked in Doc.Missing or unclear documentation
N/A
Improvement
N/A
Related existing documentation
N/A
Related issues, RFCs
#391
The text was updated successfully, but these errors were encountered: