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: more app v2 renaming #21336

Merged
merged 1 commit into from
Aug 19, 2024
Merged

docs: more app v2 renaming #21336

merged 1 commit into from
Aug 19, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Aug 17, 2024 •
edited by coderabbitai bot
Loading

Description

Follow-up of #21329.
Done already in the backports of the previous PR.

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, you can find examples of the prefixes below:
  • confirmed ! in 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
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Documentation Updates
    • Clarified terminology in documentation by replacing "app v2" with "app di" for better alignment with dependency injection framework.
    • Streamlined instructions for using AutoCLI for improved readability.
    • Enhanced integration documentation for users of depinject by removing version-specific references.

@julienrbrt julienrbrt requested a review from a team as a code owner August 17, 2024 09:15
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 17, 2024 •
edited
Loading

Walkthrough

Walkthrough

The recent changes primarily focus on updating terminology in the documentation related to the application's dependency injection framework. The term "app v2" has been replaced with "app di" to provide clarity without altering any underlying functionality. Additionally, minor adjustments to phrasing improve readability across various documents, ensuring users understand the integration and configuration processes without confusion.

Changes

File(s) Change Summary
UPGRADING.md, client/v2/README.md, Updated terminology from "app v2" to "app di" in multiple documents for clarity, with no changes to functionality.
docs/build/building-apps/03-app-upgrade.md Removed version-specific language to streamline documentation regarding depinject integration.
docs/build/building-modules/01-module-manager.md Changed references from "app v2" to "app di" for improved documentation clarity.
simapp/app_test.go Corrected a typographical error in a comment from "app v2" to "app di" without affecting code logic.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the C:CLI label Aug 17, 2024
coderabbitai[bot]
coderabbitai bot reviewed Aug 17, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 651868a and 68b011d.

Files selected for processing (5)
  • UPGRADING.md (2 hunks)
  • client/v2/README.md (1 hunks)
  • docs/build/building-apps/03-app-upgrade.md (1 hunks)
  • docs/build/building-modules/01-module-manager.md (1 hunks)
  • simapp/app_test.go (1 hunks)
Files skipped from review due to trivial changes (5)
  • UPGRADING.md
  • client/v2/README.md
  • docs/build/building-apps/03-app-upgrade.md
  • docs/build/building-modules/01-module-manager.md
  • simapp/app_test.go

coderabbitai[bot]
coderabbitai bot reviewed Aug 17, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 651868a and 68b011d.

Files selected for processing (5)
  • UPGRADING.md (2 hunks)
  • client/v2/README.md (1 hunks)
  • docs/build/building-apps/03-app-upgrade.md (1 hunks)
  • docs/build/building-modules/01-module-manager.md (1 hunks)
  • simapp/app_test.go (1 hunks)
Files skipped from review due to trivial changes (5)
  • UPGRADING.md
  • client/v2/README.md
  • docs/build/building-apps/03-app-upgrade.md
  • docs/build/building-modules/01-module-manager.md
  • simapp/app_test.go

@julienrbrt julienrbrt added this pull request to the merge queue Aug 19, 2024
Merged via the queue into main with commit d6ea8e3 Aug 19, 2024
79 of 80 checks passed
@julienrbrt julienrbrt deleted the julien/renaming branch August 19, 2024 07:20
alpe added a commit that referenced this pull request Aug 19, 2024
@alpe
Merge branch 'main' into alex/sims2_v2_spike_rebased
3043297 
* main: (76 commits)
  docs: more app v2 renaming (#21336)
  chore: update link in disclaimer (#21339)
  refactor(x/distribution): audit QA (#21316)
  docs: rename app v2 to app di when talking about runtime v0 (#21329)
  feat(schema): specify JSON mapping (#21243)
  fix(x/authz): bring back msg response in `DispatchActions` (#21044)
  chore: fix all lint issue since golangci-lint bump (#21326)
  refactor(x/mint): v0.52 audit x/mint (#21301)
  chore: fix spelling errors (#21327)
  feat: export genesis in simapp v2 (#21199)
  fix(baseapp)!: Halt at height now does not produce the halt height block (#21256)
  refactor(scripts): remove unused variable (#21320)
  chore(schema/testing): upgrade to go 1.23 iterators (#21282)
  chore: readmes + upgrading docs (#21271)
  feat(client): add auto cli for node service (#21074)
  ci: fix github workflow vulnerable to script injection (#21304)
  build(deps): Bump github.com/prometheus/client_golang from 1.19.1 to 1.20.0 (#21307)
  build(deps): use Go 1.23 instead of Go 1.22 (#21280)
  refactor(x/auth): audit x/auth changes (#21146)
  chore: remove todo: "abstract out staking message back to staking" (#21266)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@sontrinh16 sontrinh16 sontrinh16 approved these changes

@tac0turtle tac0turtle tac0turtle approved these changes

Assignees
No one assigned
Labels
C:CLI
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@julienrbrt @tac0turtle @sontrinh16