docs: add documentation site

[0x676e67]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @0x676e67, 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 introduces a brand new, comprehensive documentation site for the rnet project. Built with MkDocs, the site aims to significantly enhance the user experience by providing well-structured guides for installation and quick start, detailed API references automatically generated from code, and practical examples for various use cases. This addition will make the rnet library more accessible and easier to learn for both new and experienced users.

Highlights

• New Documentation Site: A comprehensive documentation site has been added using MkDocs, providing a centralized resource for the rnet library.
• Structured Content: The documentation includes detailed sections for installation, quick start guides, a full API reference, and practical code examples covering various rnet functionalities like basic requests, authentication, browser emulation, and WebSockets.
• Automated API Reference: The API reference pages are configured to automatically generate documentation from Python docstrings using the mkdocstrings plugin, ensuring up-to-date and consistent API details.
• Development and Deployment Workflow: Instructions for setting up, developing, building, and deploying the documentation site are provided, including a new requirements.txt for documentation dependencies and an update to .gitignore to exclude built site files.
• Project Overview and Features: The main index page of the documentation offers an overview of rnet, its key features, example usage, and important behavioral notes regarding TLS and device emulation.

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 introduces a comprehensive documentation site for rnet using MkDocs with the Material theme. The setup is well-structured, with clear separation of configuration, source files, and generated output. The documentation includes installation guides, a quick start, numerous examples, and auto-generated API references.

My review focuses on improving the accuracy and clarity of the documentation. I've identified a significant error in the installation instructions and a misleading code example for mobile browser emulation. Addressing these points will greatly enhance the user experience and prevent potential confusion.