Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

chore: update deprecated document link in .github/ISSUE_TEMPLATE #4986

Merged
merged 1 commit into from
Nov 30, 2024

Conversation

richex-cn
Copy link
Contributor

@richex-cn richex-cn commented Nov 29, 2024

https://anncwb.github.io/vue-vben-admin-doc response 404, updated document link to https://doc.vben.pro/

Summary by CodeRabbit

  • Bug Fixes

    • Updated the documentation link in the bug report template to ensure users are directed to the correct resource.
  • New Features

    • Updated the documentation link in the feature request template for accurate user guidance.

Copy link

changeset-bot bot commented Nov 29, 2024

⚠️ No Changeset found

Latest commit: acd039c

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 Nov 29, 2024

Walkthrough

The changes in this pull request involve updates to the bug report and feature request templates located in the .github/ISSUE_TEMPLATE directory. Specifically, the URLs for the "Read the docs" checkbox options in both templates have been updated from https://anncwb.github.io/vue-vben-admin-doc/ to https://doc.vben.pro/. No other modifications were made to the structure or attributes of these templates.

Changes

File Change Summary
.github/ISSUE_TEMPLATE/bug-report.yml Updated "Read the docs" URL from https://anncwb.github.io/vue-vben-admin-doc/ to https://doc.vben.pro/.
.github/ISSUE_TEMPLATE/feature-request.yml Updated "Read the docs" URL from https://anncwb.github.io/vue-vben-admin-doc/ to https://doc.vben.pro/.

Possibly related PRs

Suggested labels

chore

Poem

🐰 In the land of code, where bugs do roam,
A new path for docs, we call it home.
With a click, you’ll find, the answers you seek,
No more old links, just the new peak!
So hop along, dear coder friend,
With updated links, your troubles will end! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 253abc5 and acd039c.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/bug-report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/feature-request.yml (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • .github/ISSUE_TEMPLATE/bug-report.yml
  • .github/ISSUE_TEMPLATE/feature-request.yml

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@anncwb anncwb added the documentation Improvements or additions to documentation label Nov 30, 2024
@anncwb anncwb merged commit 7b98661 into vbenjs:main Nov 30, 2024
5 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 1, 2025
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants