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 broken links #16

Merged
merged 1 commit into from
Nov 25, 2024
Merged

🐛 Fix broken links #16

merged 1 commit into from
Nov 25, 2024

Conversation

whtsht
Copy link
Contributor

@whtsht whtsht commented Nov 24, 2024

やったこと

  • 壊れていた(正しくデザインが反映されていない)リンクを修正した

該当箇所
https://vim-denops.github.io/denops-documentation/getting-started/explanation.html#next-steps

  • Tutorial (Hello World)
  • Tutorial (Maze)

https://vim-denops.github.io/denops-documentation/tutorial/helloworld/calling-vim-features.html

  • Tutorial (Maze)

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

  • deno fmt を実行した

Summary by CodeRabbit

  • New Features

    • Updated tutorial links for "Hello World" and "Maze" to ensure accessibility.
    • Introduced a new Vim command DenopsHello for enhanced functionality within the Denops plugin.
    • Added an autocmd to automatically register the DenopsHello command upon plugin loading.
  • Bug Fixes

    • Corrected link paths in documentation for improved navigation.
  • Documentation

    • Minor formatting adjustments for better readability in the getting started guide.

Copy link

coderabbitai bot commented Nov 24, 2024

Walkthrough

The pull request updates documentation files by changing tutorial links from relative to absolute paths, ensuring consistent access to resources. Specifically, the "Hello World" and "Maze" tutorials have been updated to point to their respective absolute paths. Additionally, minor formatting adjustments were made for improved readability. The documentation for calling Vim features from a Denops plugin was also enhanced, including the registration of a new command and an autocmd for plugin loading.

Changes

File Path Change Summary
src/getting-started/explanation.md Updated tutorial links from relative to absolute paths; minor formatting adjustments made.
src/tutorial/helloworld/calling-vim-features.md Added example for registering a Vim command in Denops; updated tutorial link to absolute path.
plugin/denops-helloworld.vim Introduced an autocmd for command registration and updated the Maze tutorial link to absolute path.

Possibly related PRs

  • Add codeblock title #15: The changes in this PR include updating links in documentation, similar to the main PR's updates to tutorial links in explanation.md. Both PRs focus on enhancing the clarity and accessibility of documentation.

Poem

🐇 In the garden of code, we hop and play,
With links that now lead the right way.
From relative paths, we’ve taken flight,
To absolute trails, shining bright.
So gather 'round, let’s cheer and sing,
For clearer paths, oh what joy they bring! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9e8b6f7 and 5dfa160.

📒 Files selected for processing (2)
  • src/getting-started/explanation.md (1 hunks)
  • src/tutorial/helloworld/calling-vim-features.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • src/getting-started/explanation.md
🔇 Additional comments (2)
src/tutorial/helloworld/calling-vim-features.md (2)

Line range hint 1-64: Documentation is well-structured and clear

The documentation provides clear explanations, proper code examples, and helpful visual aids. The content flow is logical and the examples are practical.


63-63: Verify the absolute path structure

The link change from relative to absolute path aligns with the PR objectives. However, let's verify that this absolute path structure is consistent with the documentation site's URL pattern.

✅ Verification successful

Absolute path pattern for tutorial links is consistent

The verification shows that the same absolute path pattern /tutorial/maze/index.html is used consistently in other markdown files, specifically in:

  • src/tutorial/helloworld/calling-vim-features.md
  • src/getting-started/explanation.md

No relative paths using ../tutorial were found, indicating the link structure is uniform across the documentation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the consistency of documentation links
# Check if other documentation files use the same absolute path pattern

# Search for similar tutorial links in other markdown files
rg -g "*.md" '/tutorial.*index\.html'

# Also check if there are any remaining relative paths that should be updated
rg -g "*.md" '\.\./tutorial'

Length of output: 247


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.

@lambdalisue lambdalisue merged commit fe11f7a into vim-denops:main Nov 25, 2024
1 check passed
@lambdalisue
Copy link
Member

Thanks a lot 🎉

@whtsht whtsht mentioned this pull request Nov 26, 2024
2 tasks
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