Closed
Description
What were you initially searching for in the docs?
While i was browsing the docs, i've noticed something is not right with the format
and when i started to work on a PR, i've noticed a bit of inconsistency on various pages where:
- on some pages we have admonitions with title: Info/ Warning/ Note etc
- on some we don't
Describe how we could make it clearer
I'd like to suggest we adhere to a convention whereby
- every admonition will have the default title
Current
Proposed
- for cases where we provide a custom title, we prefix it with the default title in the format
<default title>: <custom title> - i.e Tip: DynamoDB
Current
Proposed
- use the example admonition instead of question mark or quote
Current
Proposed
- nice to have - collapsible blocks ( default open)
Open block
Closed block
If you happy with my suggestion, i'll start working on a PR to address all the pages from A to Z.