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

update for v4 #220

Merged
merged 1 commit into from
Jul 6, 2024
Merged

update for v4 #220

merged 1 commit into from
Jul 6, 2024

Conversation

Star585
Copy link
Collaborator

@Star585 Star585 commented Jul 6, 2024

Summary by CodeRabbit

  • Configuration Update

    • Updated baseUrl to root directory for better path management.
  • Documentation

    • Updated documentation to reflect changes from participating in the main network to the 2.0 network for Starcoin across various operating systems.

Copy link

coderabbitai bot commented Jul 6, 2024

Walkthrough

The recent updates to docusaurus.config.js and the Vega Network documentation reflect a switch in the baseUrl and a transition from the main network to the 2.0 network for Starcoin. Specifically, baseUrl was simplified, and references to the network were updated for clarity across various platforms.

Changes

File Path Change Summary
docusaurus.config.js Updated baseUrl from /starcoin-cookbook/ to /.
i18n/zh/docusaurus-plugin-content-docs/.../08-vega-network.md Updated network references from 'main network' to '2.0 network' across multiple operating systems.

Poem

In code’s quiet dance, a change we see,
The baseUrl shifts to set us free.
Starcoin’s network, version two,
Guides us forward, tried and true.
With every line, a tale does spin,
Progress whispers, let’s begin! 🚀


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 Configration 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.

Copy link
Contributor

@timyangnet timyangnet left a comment

Choose a reason for hiding this comment

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

ok

@Star585 Star585 merged commit 97cc9b6 into main Jul 6, 2024
2 of 3 checks passed
@Star585 Star585 deleted the v4 branch July 6, 2024 01:40
Copy link

@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

Outside diff range and nitpick comments (1)
i18n/zh/docusaurus-plugin-content-docs/current/02-getting-started/02-setup/08-vega-network.md (1)

Line range hint 80-136:
LGTM! Fix markdown linting issue.

The instructions for setting up the Starcoin node on Linux for the 2.0 network are clear and detailed. However, there's a markdown linting issue with using emphasis instead of a heading.

- **1. 启动**
+ ### 启动
Tools
Markdownlint

82-82: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 75abe62 and 505f7f8.

Files selected for processing (2)
  • docusaurus.config.js (1 hunks)
  • i18n/zh/docusaurus-plugin-content-docs/current/02-getting-started/02-setup/08-vega-network.md (3 hunks)
Files skipped from review due to trivial changes (1)
  • docusaurus.config.js
Additional context used
Markdownlint
i18n/zh/docusaurus-plugin-content-docs/current/02-getting-started/02-setup/08-vega-network.md

9-9: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


82-82: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Additional comments not posted (2)
i18n/zh/docusaurus-plugin-content-docs/current/02-getting-started/02-setup/08-vega-network.md (2)

Line range hint 7-79:
LGTM!

The instructions for setting up the Starcoin node on Windows for the 2.0 network are clear and detailed.

Tools
Markdownlint

9-9: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


Line range hint 137-193:
LGTM!

The instructions for setting up the Starcoin node using Docker for the 2.0 network are clear and detailed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants