feat: Dark mode for mkdocs

[carlspring]

Pull Request Description

This pull request closes #708 .

Acceptance Test

• [ ] Building the code with gradle clean build still works.

Questions

• Does this pull request break backward compatibility?

  • [ ] Yes and my commit follows the Conventional Commits Specification
  • [ ] No

• Does this pull request require other pull requests to be merged first?

  • [ ] Yes, please see #...
  • [ ] No

• Does this require an update of the documentation?

  • [ ] Yes, please see [provide details here]
  • [ ] No

Summary by CodeRabbit

• Documentation

  • Commented out license text in Apache 2.0 and a line in the main documentation index.
  • Updated MIT license text inclusion method.
  • Adjusted theme settings, plugin configurations, markdown extensions, social links, and navigation structure in mkdocs.yml.

• Chores

  • Upgraded image version in docker-compose.yml to squidfunk/mkdocs-material:9.
  • Updated various dependencies in requirements.txt.

[carlspring]

@coderabbitai review

[coderabbitai[bot]]

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai[bot]]

Walkthrough

This update primarily focuses on enhancing the documentation setup and dependencies. Key changes include the implementation of dark mode for mkdocs, updates to documentation files, and upgrades to dependencies and Docker images. These changes aim to improve the user experience and maintain compatibility with the latest tools and libraries.

Changes

Files/Groups	Change Summary
.../contributing/legal/license-Apache-2.0.md	Commented out the license text using Markdown comment syntax.
.../contributing/legal/license-MIT.md	Modified the way the external file is included in the license text.
docs/content/index.md	Commented out a line that includes a properties file path in the documentation.
docs/docker-compose.yml	Updated image version from squidfunk/mkdocs-material:5.5.9-custom to squidfunk/mkdocs-material:9.
docs/mkdocs.yml	Adjusted theme's palette toggles, features list, plugins configurations, markdown extensions, and navigation structure.
docs/requirements.txt	Updated various dependencies and commented out jinja2<3.1.0.

Assessment against linked issues

Objective (Issue #708)	Addressed	Explanation
Set up dark mode for mkdocs	✅

Poem

In the docs, a change took flight, Dark mode now brings delight. Dependencies fresh, all in line, Mkdocs shines, truly divine. With updates clear and bright, Our work now feels so light.

---

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.
  • @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 as 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.

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.