Put a link for denops_std API reference

[kyoh86]

The API for denops_std is documented in deno.land, but I still often get lost trying to reach it.

https://deno.land/x/denops_std/mod.ts

I would like to put a link to the denops_std API reference in the help document.

Referred issue: #329

Summary by CodeRabbit

• Documentation
  • Updated URLs for Denops Document and Wiki.
  • Added a new link to the API Reference.

[coderabbitai]

Walkthrough

The proposed changes update the documentation for the Denops project, specifically enhancing accessibility to the API references and improving navigation by updating URLs and adding new links.

Changes

Files	Change Summary
doc/denops.txt	Updated URLs for Denops Document and Wiki; added new API Reference link

Possibly related issues

• Difficult to get to API reference for denops_std #329: The issue requests a more accessible link to the denops_std API documentation, which aligns with the PR's goal of improving documentation accessibility.

🐇🌼
A hop, a skip, a documentation flip,
New paths we lay, for ease, hooray!
Links once hidden, now brightly bidden,
In docs so clear, the route's near, dear!
📖🔗

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c057cdf and 8e5f9a4.

Files selected for processing (1)

• doc/denops.txt (1 hunks)

Additional comments not posted (3)

doc/denops.txt (3)

23-23: Ensure the updated URL for the Denops Document is correct and accessible.

Verification successful

---

The verification script successfully accessed the updated URL for the Denops Document and received a HTTP status code of 200, indicating that the URL is correct and the resource is accessible. This confirms that the updated URL in the documentation is valid.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify the accessibility of the updated URL for the Denops Document.
curl -o /dev/null -s -w "%{http_code}\n" https://vim-denops.github.io/denops-documentation/ | grep 200

Length of output: 108

---

24-24: Verify the updated URL for the Wiki is correct and accessible.

Verification successful

---

The verification script successfully accessed the updated URL for the Wiki (https://github.com/vim-denops/denops.vim/wiki) and received a HTTP status code of 200, indicating that the URL is correct and accessible.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify the accessibility of the updated URL for the Wiki.
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/vim-denops/denops.vim/wiki | grep 200

Length of output: 103

---

25-25: Confirm the new link to the denops_std API Reference is correct and accessible.

Verification successful

The shell script was designed to check the HTTP status code of the URL https://deno.land/x/denops_std/mod.ts by using curl and then filtering the output with grep to see if it returns 200, which indicates that the page is successfully accessible. The absence of any output from the grep command suggests that the HTTP status code returned was not 200, implying that the URL might not be accessible or does not return a successful status.

Given this result, it is necessary to further investigate the accessibility of the URL to ensure the correctness of the link provided in the documentation. This could involve checking for different HTTP status codes or attempting to access the URL with different methods or tools.

Since the initial verification script did not confirm the accessibility of the URL as expected, I recommend running additional scripts to further investigate the status of the URL.

---

The output from the latest script reveals that the URL https://deno.land/x/denops_std/mod.ts results in an HTTP 302 response, which is a redirection status. The location header in the response indicates that the actual resource is located at /x/denops_std@v6.4.0/mod.ts. This suggests that the URL provided in the documentation automatically redirects to the latest version of the resource, which is currently version v6.4.0.

This redirection is not inherently problematic as long as the redirected URL is accessible and provides the intended content. However, it's important to note that the original URL does not directly serve the content but redirects to a version-specific URL. This behavior should be acceptable as long as users are aware that they might be redirected to the latest version of the API documentation.

Given this information, the link in the documentation can be considered correct and functional, as it successfully redirects to the current version of the API reference. Therefore, the documentation update with the new link is verified to be accurate and functional.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify the accessibility of the new link to the `denops_std` API Reference.
curl -o /dev/null -s -w "%{http_code}\n" https://deno.land/x/denops_std/mod.ts | grep 200

Length of output: 91

---

---

Script:

#!/bin/bash
# Check the full HTTP response headers and status code for the URL
curl -I https://deno.land/x/denops_std/mod.ts

Length of output: 1038

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.81%. Comparing base (c057cdf) to head (8e5f9a4).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #330   +/-   ##
=======================================
  Coverage   89.81%   89.81%           
=======================================
  Files           9        9           
  Lines         648      648           
  Branches       61       61           
=======================================
  Hits          582      582           
  Misses         66       66           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.