From 666d3779c32a1634564696eb825655d7dfcc2779 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 26 Jun 2026 21:29:34 -0400 Subject: [PATCH] docs: Migrate org README to Markdown format Replaces the legacy `README.rst` with a new root `README.md` that adds branded header content, badges, and improved localization/community sections while preserving the core project overview. Also updates `profile/README.md` to use the SVG logo image in the header for consistent branding across org-facing docs. --- README.md | 51 ++++++++++++++++++++++++++++++++++ README.rst | 25 ----------------- docs/source/about/overview.md | 2 ++ docs/source/about/overview.rst | 1 - profile/README.md | 6 +++- 5 files changed, 58 insertions(+), 27 deletions(-) create mode 100644 README.md delete mode 100644 README.rst create mode 100644 docs/source/about/overview.md delete mode 100644 docs/source/about/overview.rst diff --git a/README.md b/README.md new file mode 100644 index 00000000..f26517c5 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +
+ LizardByte icon +

LizardByte

+

Org level docs and standards for LizardByte.

+
+ +
+ Read the Docs + SonarCloud +
+ +# Overview + +LizardByte has the full documentation hosted on [Read the Docs](http://lizardbyte.readthedocs.io/). + +This documentation is being localized on [Crowdin](https://crowdin.com/project/lizardbyte-docs). + +

+ + LizardByte documentation localization progress + +

+ +> [!NOTE] +> **Community!** +> +> Accurate translations depend on contributions from amazing community members, like you! If you would like to +> contribute to the localization of this documentation, please visit our +> [Crowdin project](https://crowdin.com/project/lizardbyte-docs). +> Thanks to all the contributors for their hard work! + +

+ + Crowdin contributors + +

+ +## About + +[LizardByte](https://app.lizardbyte.dev) is developing self hosted cloud game streaming solutions. +These applications are developed by volunteers in their free time. If you like our products please consider donating! diff --git a/README.rst b/README.rst deleted file mode 100644 index eb5ed8d3..00000000 --- a/README.rst +++ /dev/null @@ -1,25 +0,0 @@ -Overview -======== -LizardByte has the full documentation hosted on `Read the Docs `__. - -This documentation is being localized on `Crowdin `__. - -.. image:: https://raw.githubusercontent.com/LizardByte/i18n/refs/heads/crowdin-progress/LizardByte_docs_graph.svg? - :align: center - :target: https://crowdin.com/project/lizardbyte-docs - -.. admonition:: Community! - - Accurate translations depend on contributions from amazing community members, like you! If you would like to - contribute to the localization of this documentation, please visit our - `Crowdin project `__. - Thanks to all the contributors for their hard work! - -.. image:: https://raw.githubusercontent.com/LizardByte/contributors/refs/heads/dist/crowdin.614257.svg? - :align: center - :target: https://crowdin.com/project/lizardbyte-docs - -About ------ -`LizardByte `__ is developing self hosted cloud game streaming solutions. -These applications are developed by volunteers in their free time. If you like our products please consider donating! diff --git a/docs/source/about/overview.md b/docs/source/about/overview.md new file mode 100644 index 00000000..c5bad663 --- /dev/null +++ b/docs/source/about/overview.md @@ -0,0 +1,2 @@ +```{include} ../../../README.md +``` diff --git a/docs/source/about/overview.rst b/docs/source/about/overview.rst deleted file mode 100644 index e4a3ad51..00000000 --- a/docs/source/about/overview.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../../README.rst diff --git a/profile/README.md b/profile/README.md index 33e01bc0..db45d0aa 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,5 +1,9 @@
- LizardByte Banner + LizardByte Banner

LizardByte

Discover the world of self-hosted cloud gaming!