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

fix: Fix documentation url in the ReadMe #2932

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Conversation

nunoar
Copy link
Contributor

@nunoar nunoar commented Dec 10, 2024

Information

Type Breaking change
Doc No

Documentation

Fixed the documentation link.

Summary by CodeRabbit

  • Documentation
    • Updated documentation links for Swagger tutorials.
    • Improved phrasing for contributing guidelines link.

Copy link

coderabbitai bot commented Dec 10, 2024

Walkthrough

The changes in the readme.md file for the @tsed/openspec package involve updates to documentation links and minor text adjustments. The URL for Swagger tutorials has been corrected, and the phrasing of the contributing guidelines link has been modified for clarity. The overall structure and content of the readme remain unchanged, with no modifications to installation instructions or usage examples.

Changes

File Change Summary
packages/specs/openspec/readme.md Updated Swagger tutorial URL and modified contributing guidelines link phrasing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    User->>Documentation: Access readme.md
    Documentation-->>User: Display updated links and guidelines
Loading

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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

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: 1

🧹 Outside diff range comments (1)
packages/specs/openspec/readme.md (1)

Line range hint 52-52: Fix broken contributing guidelines link

The contributing guidelines link appears to be malformed (missing slash):

-Please read [contributing guidelines here](https://tsed.devcontributing.html)
+Please read [contributing guidelines here](https://tsed.dev/contributing.html)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between 324cbd6 and c8fc76a.

📒 Files selected for processing (1)
  • packages/specs/openspec/readme.md (1 hunks)

packages/specs/openspec/readme.md Show resolved Hide resolved
@Romakita Romakita merged commit ad41468 into tsedio:production Dec 10, 2024
10 checks passed
@Romakita
Copy link
Collaborator

🎉 This PR is included in version 8.3.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

2 participants