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

🐛 Changed to relative link #17

Merged
merged 1 commit into from
Nov 26, 2024
Merged

Conversation

whtsht
Copy link
Contributor

@whtsht whtsht commented Nov 26, 2024

#16 にて、絶対パスを指定したらリンクが壊れてしまったので、相対パスに戻した

  • ローカルでリンクが直っていることを確認した
  • deno fmt を実行した

Summary by CodeRabbit

  • New Features

    • Enhanced documentation for the "Getting Started" section, clarifying Denops functionality and its integration with Vim and Neovim.
    • Updated examples for calling Vim features from Denops plugins, including command registration and asynchronous initialization.
  • Documentation

    • Improved explanations regarding Denops plugin registration and directory structure.
    • Adjusted tutorial links for accuracy and accessibility.

Copy link

coderabbitai bot commented Nov 26, 2024

Walkthrough

The pull request modifies documentation files related to Denops and Vim plugins, enhancing clarity and depth. Changes include an expanded explanation of Denops functionality, plugin registration processes, and the structure of Denops plugins. Additionally, updates to example code demonstrate command registration and autocmd usage. The documentation now provides a more comprehensive overview of available methods on the denops object and corrects tutorial links for accuracy.

Changes

File Path Change Summary
src/getting-started/explanation.md Enhanced structure and content regarding Denops functionality, plugin registration, and directory structure. Updated explanations of the main.ts code, including imports and user-defined APIs. Improved list of methods on the denops object with examples. Adjusted tutorial links for correct paths.
src/tutorial/helloworld/calling-vim-features.md Updated example code for registering the DenopsHello command and defined the init function in the dispatcher object. Modified autocmd in plugin/denops-helloworld.vim for automatic init API calls. Updated link to the "Maze" tutorial for correct path.

Possibly related PRs

  • 🐛 Fix broken links #16: The changes in this PR involve updates to the src/getting-started/explanation.md file, which is also modified in the main PR. Both PRs focus on enhancing the documentation related to Denops, with 🐛 Fix broken links #16 specifically addressing broken links in the same file.

Poem

🐇 In the land of Denops, where plugins thrive,
A guide was crafted to help us survive.
With commands and features, so clear and bright,
We hop through the code, in pure delight.
So grab your Vim, let’s dance and play,
With Denops by our side, we’ll code all day! 🌟


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.

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fe11f7a and 54f7455.

📒 Files selected for processing (2)
  • src/getting-started/explanation.md (1 hunks)
  • src/tutorial/helloworld/calling-vim-features.md (1 hunks)
🔇 Additional comments (2)
src/tutorial/helloworld/calling-vim-features.md (2)

Line range hint 8-26: Well-structured TypeScript implementation!

The code demonstrates good practices:

  • Proper type safety with unknownutil assertions
  • Clear separation of command registration and handler logic
  • Appropriate use of JSR imports with version constraints

Line range hint 28-38: Vim script follows best practices!

The implementation includes all necessary safeguards:

  • Proper guard against double loading
  • Correct autocmd group management
  • Appropriate event handling for plugin initialization

src/getting-started/explanation.md Show resolved Hide resolved
@lambdalisue lambdalisue merged commit 13390fa into vim-denops:main Nov 26, 2024
1 check passed
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