docs: split development / stable

[JanPokorny]

Summary

Linked Issues

Fixes #1707

Documentation

• No Docs Needed:

If this PR adds new feature or changes existing. Make sure documentation is adjusted accordingly. If the docs is not needed, please explain why.

[gemini-code-assist]

Summary of Changes

Hello @JanPokorny, 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 robust documentation versioning system, distinguishing between 'development' and 'stable' content. It involves a comprehensive restructuring of the documentation file paths, updating the navigation configuration to reflect these versions, and establishing an automated process to manage the synchronization of documentation content between these two states during release cycles. This enhancement aims to provide clearer, version-specific documentation for users and developers.

Highlights

• Documentation Versioning: Implemented a clear separation between 'development' and 'stable' versions of the documentation, providing distinct content for different release stages.
• File Restructuring: All existing documentation files have been moved into a new docs/development/ directory to house in-progress and future documentation.
• New Stable Documentation: A complete set of documentation files has been added under docs/stable/, representing the current stable release of the project's documentation.
• Navigation Configuration Update: The docs.json file has been updated to introduce a versioned navigation structure, allowing users to easily switch between 'stable' and 'development' documentation views.
• Automated Documentation Sync: A new task has been added to tasks.toml to automate the process of syncing the development documentation to the stable documentation during release cycles, ensuring consistency and reducing manual effort.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/docs-check.yaml

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 versioning system for the documentation, splitting it into stable and development branches. This is a significant structural change involving renaming many files and updating the navigation configuration in docs/docs.json. The changes are consistent with the goal of versioning the documentation. My main feedback concerns the maintainability of the new docs.json due to duplicated configuration, which I've detailed in a specific comment. The related update to the release script in tasks.toml appears to be functionally correct for this new structure.