Documentation (all): Add getting started section on the home page of doc
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:
- CDK (we have already had this in
examples/cdkfolder) - Serverless Framework
- SAM
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
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.
⚠️ COMMENT VISIBILITY WARNING ⚠️
Comments on closed issues are hard for our team to see. If you need more assistance, please either tag a team member or open a new issue that references this one. If you wish to keep having a conversation with other community members under this issue feel free to do so.