Make more easy to access denops_std module API reference

[kyoh86]

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

I'm suggesting the following improvements in thi PR:

• Create a page in Denops Documents that introduces the API reference at the heading level, and link to the denops_std documentation from the page.

  • 

• (This is not directly related to this issue, but since the standard theme of Denops Documents (Light) is almost indistinguishable from the links in the document, we would like to use a more distinguishable style (Coal) as the default.

  • before:
    • 
  • after:
    • 

Referred issue: vim-denops/denops.vim#329.

Summary by CodeRabbit

• New Features

  • Updated the default theme of the documentation to "coal".
  • Added a new "API Reference" section to the documentation, detailing functions and utilities for developing Denops plugins with links to external detailed references.

• Documentation

  • Enhanced the documentation structure by introducing a dedicated API reference guide for the denops_std module.

[coderabbitai]

Walkthrough

The changes encompass updating the book.toml to specify a new default theme for HTML output, appending an "API Reference" section to the documentation summary, and introducing an extensive API Reference page for the denops_std module to assist Denops plugin developers.

Changes

File	Change Summary
book.toml	Added [output.html] section with default-theme set to "coal"
src/SUMMARY.md	Added "API Reference" in the list of tutorials
src/api-reference.md	Introduced API Reference for denops_std module

Possibly related issues

• Difficult to get to API reference for denops_std denops.vim#329: The issue requests easier access to denops_std API documentation, which is directly addressed by adding an API Reference section in the documentation.

Poem

🐇 Oh hop and skip, the changes are slick,
📚 In books and docs, with themes not a trick!
🌌 A theme so dark, like coal in the night,
🌟 For eyes that seek code, it's quite a sight!
🎉 Celebrate the docs, they're clearer, alright!

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between eea7b0f and c68ce4c.

Files selected for processing (3)

• book.toml (1 hunks)
• src/SUMMARY.md (1 hunks)
• src/api-reference.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• book.toml

Additional comments not posted (1)

src/SUMMARY.md (1)

20-20: The addition of the "API Reference" link to the table of contents is correctly implemented.

---

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.

[coderabbitai]

Actionable comments posted: 1

[coderabbitai]

Actionable comments posted: 1

[lambdalisue]

Thanks 🎉