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

chore(docs): correct the file path in the markdown for the GitHub website #4254

Merged
merged 1 commit into from
Aug 28, 2024

Conversation

a63149300
Copy link
Contributor

@a63149300 a63149300 commented Aug 28, 2024

…site

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features

    • Updated the documentation edit links for both English and Chinese versions to direct users to the correct source file locations in the new src subdirectory.
  • Documentation

    • Improved clarity of edit links to enhance contributor experience when accessing documentation for editing on GitHub.

@a63149300 a63149300 requested review from anncwb, vince292007 and a team as code owners August 28, 2024 01:55
Copy link

changeset-bot bot commented Aug 28, 2024

⚠️ No Changeset found

Latest commit: 007b059

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Aug 28, 2024

Walkthrough

The changes involve updating the editLink configuration in the VitePress documentation for both English and Chinese exports. Specifically, the URL pattern for editing links has been modified to include a src directory in the path. This adjustment affects how contributors access documentation editing on GitHub, ensuring that links point to the correct source file locations.

Changes

Files Change Summary
docs/.vitepress/config/en.mts Updated editLink.pattern from docs/:path to docs/src/:path.
docs/.vitepress/config/zh.mts Updated editLink.pattern to include src/ in the URL path for editing documentation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VitePress
    participant GitHub

    User->>VitePress: Requests to edit documentation
    VitePress->>GitHub: Redirects to edit link (with new src path)
    GitHub-->>User: Displays source file for editing
Loading

🐇 "In the land of docs, a change did spring,
A hop to src, oh what joy it brings!
Edit links now point to the right place,
A clearer path for every brave face.
So gather 'round, contributors dear,
With a hop and a skip, let’s give a cheer!" 🎉


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.

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 UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6d24369 and 007b059.

Files selected for processing (2)
  • docs/.vitepress/config/en.mts (1 hunks)
  • docs/.vitepress/config/zh.mts (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/.vitepress/config/en.mts
Additional comments not posted (1)
docs/.vitepress/config/zh.mts (1)

16-17: LGTM!

The editLink.pattern string has been correctly modified to include the src/ segment in the URL path, ensuring that links point to the correct source file locations.

The code changes are approved.

@vince292007 vince292007 changed the title chore(docs): correct the file path in the markdown for the GitHub web… chore(docs): correct the file path in the markdown for the GitHub website Aug 28, 2024
@vince292007 vince292007 merged commit 453a3a8 into vbenjs:main Aug 28, 2024
17 checks passed
@a63149300 a63149300 deleted the hotfix/wrong-md-file-path branch August 28, 2024 06:37
@github-actions github-actions bot locked and limited conversation to collaborators Sep 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants