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: improve usage of :::note #17132

Merged
merged 3 commits into from
Jul 26, 2023
Merged

docs: improve usage of :::note #17132

merged 3 commits into from
Jul 26, 2023

Conversation

julienrbrt
Copy link
Member

Description

I was reading docs on docusaurus/docus yesterday and found this will make our header for pre-requisite reading look nicer.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@julienrbrt julienrbrt added backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release labels Jul 26, 2023
@julienrbrt julienrbrt requested a review from a team as a code owner July 26, 2023 08:46
@julienrbrt julienrbrt changed the title docs: improve usage of ::: note docs: improve usage of :::note Jul 26, 2023
@tac0turtle tac0turtle added this pull request to the merge queue Jul 26, 2023
Merged via the queue into main with commit 2c5f36c Jul 26, 2023
@tac0turtle tac0turtle deleted the julien/docs branch July 26, 2023 08:55
mergify bot pushed a commit that referenced this pull request Jul 26, 2023
(cherry picked from commit 2c5f36c)
mergify bot pushed a commit that referenced this pull request Jul 26, 2023
(cherry picked from commit 2c5f36c)

# Conflicts:
#	docs/docs/basics/01-tx-lifecycle.md
#	docs/docs/building-apps/03-app-upgrade.md
#	docs/docs/building-modules/14-simulator.md
julienrbrt added a commit that referenced this pull request Jul 26, 2023
Co-authored-by: Julien Robert <julien@rbrt.fr>
julienrbrt added a commit that referenced this pull request Jul 26, 2023
Co-authored-by: Julien Robert <julien@rbrt.fr>
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C:x/auth
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants