Skip to content
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: Admonitions consitency #917

Closed
DanyC97 opened this issue Dec 20, 2021 · 2 comments
Closed

Docs: Admonitions consitency #917

DanyC97 opened this issue Dec 20, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@DanyC97
Copy link
Contributor

DanyC97 commented Dec 20, 2021

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.

@DanyC97 DanyC97 added the documentation Improvements or additions to documentation label Dec 20, 2021
@heitorlessa
Copy link
Contributor

I like them!!! Please go ahead and we can make some small tweaks as part of the PR :) Thank you so much @DanyC97 !

@heitorlessa heitorlessa added this to the 1.24.0 milestone Dec 21, 2021
@heitorlessa heitorlessa added the pending-release Fix or implementation already in dev waiting to be released label Dec 31, 2021
@heitorlessa
Copy link
Contributor

Hey @DanyC97 thank you again so much for the help here, docs is so crucial to us and it's hard to get quality contributions like these.

Now available in the latest docs!

@heitorlessa heitorlessa removed the pending-release Fix or implementation already in dev waiting to be released label Jan 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants