CI: Run link checker and build documentation as GHA workflow

[amotl]

What's Inside

• Run link checker and docs build on CI/GHA, for QA purposes, so that broken links don't go unnoticed.
• While fixing a few of the broken links on the documentation, it also has been improved a bit beyond QA purposes.

[coderabbitai]

Walkthrough

The pull request includes updates to several documentation files and the responder/api.py file. Key changes involve the modification of badges in the README.md and index.rst files, improvements to the Sphinx configuration in conf.py, and enhancements to docstrings in the API class within api.py. The overall goal is to improve clarity, consistency, and accuracy across the documentation without altering the functionality of the framework.

Changes

File	Change Summary
README.md	Updated badge section: renamed "Build Status" to "ci-tests", added "ci-docs", reformatted labels.
docs/source/conf.py	Changed source_suffix to dictionary format, added linkcheck_ignore, updated intersphinx_mapping.
docs/source/index.rst	Modified badge section, revised text for clarity, updated links and testimonials.
docs/source/quickstart.rst	Changed "jinja2" to "Jinja", added hyperlink to Jinja documentation.
responder/api.py	Updated docstrings for methods in the API class for clarity and consistency.
docs/source/_templates/sidebarintro.html	Updated Twitter link to reflect new URL.
docs/source/_templates/sidebarlogo.html	Updated Twitter link to reflect new URL.
docs/source/_templates/hacks.html	Added GitHub buttons script, updated CSS, and integrated UserVoice SDK.

Possibly related PRs

• Documentation: Fix broken links in README #544: The changes in the README.md file related to link updates are directly connected to the modifications made in the same file in the main PR, which also involved updates to the README content.

Suggested reviewers

• kennethreitz

Poem

🐇 In the garden of code, we hop and play,
With badges bright, we pave the way.
Jinja's name shines, clear and true,
Documentation fresh, just for you!
So let’s cheer for clarity, bright and bold,
In the world of Responder, new tales unfold! 🌼

---

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>, 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.