Skip to content

Docs: Admonitions consitency #917

Closed
Closed
@DanyC97

Description

@DanyC97

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

image

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

image

Proposed

image

  • 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

image

Proposed

image

  • use the example admonition instead of question mark or quote

Current

image

Proposed

image

  • nice to have - collapsible blocks ( default open)

Open block

image

Closed block

image

If you happy with my suggestion, i'll start working on a PR to address all the pages from A to Z.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions