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.

Sign up for GitHub

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

Jump to bottom

docs: update for 0.38 #16501

Merged
merged 27 commits into from
Jun 27, 2023
Merged

docs: update for 0.38 #16501

merged 27 commits into from
Jun 27, 2023

Conversation

tac0turtle
Copy link
Member

Description

Closes: #16481

update docs in preparation for 0.38

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
  • 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)

@tac0turtle tac0turtle mentioned this pull request Jun 15, 2023
Closed
@tac0turtle tac0turtle marked this pull request as ready for review June 16, 2023 11:49
@tac0turtle tac0turtle requested a review from a team as a code owner June 16, 2023 11:49
julienrbrt
julienrbrt requested changes Jun 16, 2023
View reviewed changes
docs/docs/basics/00-app-anatomy.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the codeblocks here show the wrong code (it moved since v0.47, so the line must change too).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i can do the whole repo mainly did the things i touched but can do others

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean in that file. Doing the whole repo should be a separate PR imho. It is really awful to do and verify 😅

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i did the whole repo lol

docs/docs/basics/01-tx-lifecycle.md
-----------------------
| BeginBlock |
-----------------------
-------------------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we get the pretty alignment back?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you know an extension to do this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This diagram will suffice for now but I think we should get the icf designer to do a fancy version wyt?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

im good with that

docs/docs/basics/00-app-anatomy.md Show resolved Hide resolved
docs/docs/basics/01-tx-lifecycle.md Show resolved Hide resolved
docs/docs/basics/01-tx-lifecycle.md Outdated Show resolved Hide resolved
docs/docs/basics/04-gas-fees.md Outdated Show resolved Hide resolved
docs/docs/building-modules/01-module-manager.md Outdated Show resolved Hide resolved
docs/docs/core/00-baseapp.md Outdated Show resolved Hide resolved
docs/docs/core/00-baseapp.md Outdated Show resolved Hide resolved
docs/docs/core/00-baseapp.md Show resolved Hide resolved
@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Jun 20, 2023
julienrbrt
julienrbrt reviewed Jun 20, 2023
View reviewed changes
docs/docs/basics/00-app-anatomy.md Outdated Show resolved Hide resolved
docs/docs/basics/00-app-anatomy.md Outdated Show resolved Hide resolved
docs/docs/building-modules/16-testing.md Outdated Show resolved Hide resolved
docs/docs/building-modules/16-testing.md Outdated Show resolved Hide resolved
samricotta
samricotta reviewed Jun 20, 2023
View reviewed changes
docs/docs/basics/00-app-anatomy.md Outdated Show resolved Hide resolved
docs/docs/basics/01-tx-lifecycle.md Outdated Show resolved Hide resolved
docs/docs/basics/01-tx-lifecycle.md Outdated Show resolved Hide resolved
tac0turtle and others added 6 commits June 22, 2023 10:49
@tac0turtle @samricotta
Update docs/docs/basics/00-app-anatomy.md
d72df67 
Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com>
@tac0turtle @samricotta
Update docs/docs/basics/01-tx-lifecycle.md
037805a 
Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com>
@tac0turtle @samricotta
Update docs/docs/basics/01-tx-lifecycle.md
84171cf 
Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com>
@tac0turtle
Merge branch 'main' into marko/16481_docs
6f197b5
@tac0turtle
address comments
f9778fe
@tac0turtle
address comments
ad85832
samricotta
samricotta reviewed Jun 27, 2023
View reviewed changes
docs/docs/basics/01-tx-lifecycle.md
-----------------------
| BeginBlock |
-----------------------
-------------------
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This diagram will suffice for now but I think we should get the icf designer to do a fancy version wyt?

docs/docs/building-modules/05-beginblock-endblock.md Outdated Show resolved Hide resolved
docs/docs/building-modules/16-testing.md Outdated Show resolved Hide resolved
tac0turtle and others added 2 commits June 27, 2023 14:11
@tac0turtle @samricotta
Update docs/docs/building-modules/16-testing.md
31c3231 
Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com>
@tac0turtle
remove extra line
654465e
julienrbrt
julienrbrt approved these changes Jun 27, 2023
View reviewed changes
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@tac0turtle tac0turtle added this pull request to the merge queue Jun 27, 2023
Merged via the queue into main with commit de73179 Jun 27, 2023
42 checks passed
@tac0turtle tac0turtle deleted the marko/16481_docs branch June 27, 2023 12:37
mergify bot pushed a commit that referenced this pull request Jun 27, 2023
@tac0turtle @mergify
docs: update for 0.38 (#16501)
d814a99 
Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com>
(cherry picked from commit de73179)
@mergify mergify bot mentioned this pull request Jun 27, 2023
Merged
julienrbrt pushed a commit that referenced this pull request Jun 27, 2023
@mergify @tac0turtle
docs: update for 0.38 (backport #16501) (#16719)
6f2c021 
Co-authored-by: Marko <marbar3778@yahoo.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samricotta samricotta samricotta left review comments

@julienrbrt julienrbrt julienrbrt approved these changes

Assignees

@julienrbrt julienrbrt

@samricotta samricotta

Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Docs]: Update docs to comet 0.38
3 participants
@tac0turtle @julienrbrt @samricotta