[docs] port to mkdocs

[MihirJagtap]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @MihirJagtap, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request represents a significant overhaul of the project's documentation infrastructure, transitioning from Sphinx to MkDocs. The change aims to modernize the documentation's appearance, improve maintainability, and streamline the process of generating and presenting content, particularly for code examples and API references. This migration involved extensive file renaming, content adaptation to MkDocs syntax, and the introduction of new configuration and styling assets.

Highlights

• Documentation System Migration: The project's documentation has been fully migrated from Sphinx to MkDocs, involving a complete restructuring of the documentation directory and updating all relevant files.
• Updated Documentation Structure: All documentation files previously located under docs/source/ have been moved directly into the docs/ directory, reflecting the new MkDocs-based structure.
• MkDocs Configuration and Assets: A new mkdocs.yml configuration file has been added, along with custom CSS, JavaScript, and SVG logo assets to support the new MkDocs theme and styling.
• Automated Example Generation: The generate_examples.py script was updated to produce MkDocs-compatible example pages, ensuring that code examples and their associated files are correctly formatted and linked within the new documentation.
• API Reference Overhaul: New API reference pages (docs/api/fastvideo.md, docs/api/summary.md) have been introduced, leveraging MkDocs' capabilities for presenting API documentation.
• Improved Developer Environment Documentation: Existing developer environment guides (Docker, RunPod) and contributing overviews have been updated and integrated into the new MkDocs framework, removing old Sphinx-specific directives.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/docs.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request migrates the documentation from Sphinx to MkDocs. The changes are extensive and well-executed for the most part, including new configuration files, updated scripts, and restructured markdown files. However, I've identified a few critical issues that could impact the correctness and completeness of the new documentation site. These include incorrect syntax for the documentation generation tool and missing content that was present in the previous version. Addressing these points will help ensure a successful migration.

[gemini-code-assist]

This command appears to be incorrect. The path is duplicated and points to a directory instead of a script. Additionally, the instruction is for 'DMD-only distillation', but there doesn't seem to be a corresponding script in this example's directory. Please verify the correct command and script to run.