+12
fcd7c979df
fcd7c979df
Co-authored-by: Artur <145776561+arturict@users.noreply.github.com> Co-authored-by: arturict <arturict@users.noreply.github.com> Co-authored-by: Thomas <thomas@ajnart.fr> Co-authored-by: Afonso Jorge Ramos <afonsojorgeramos@gmail.com> Co-authored-by: Danura30082 <danura30082+github@gmail.com> Co-authored-by: Kushie <122986913+kushiemoon-dev@users.noreply.github.com> Co-authored-by: ajnart <thomas@ajnart.fr> Co-authored-by: ajnart <thomas@ajnart.dev> Co-authored-by: chenjun <chenjun@foxmail.com> Co-authored-by: Wikibear <wikibear@users.noreply.github.com> Co-authored-by: Bergasha <bergasha@gmail.com> Co-authored-by: leafyelin <43306196+leafyelin@users.noreply.github.com> Co-authored-by: Lucas Araujo <lucas.lra@gmail.com> Co-authored-by: GreenMonito <86085570+GreenMonito@users.noreply.github.com> Co-authored-by: Nerdy-Technician <roffo@nerdy-technician.social> Co-authored-by: Jun <34545896+jcstrong@users.noreply.github.com> Co-authored-by: Edmond Abraham <54119952+gitedmond@users.noreply.github.com> Co-authored-by: thrawnx <tight.bulb9384@fastmail.com> Co-authored-by: Chris <58918656+nordada@users.noreply.github.com> Co-authored-by: yi111 <153097222+Yi-111-a@users.noreply.github.com> Co-authored-by: Yanis <naamaneyanis@gmail.com> Co-authored-by: Wikibear <me@sej.de> Co-authored-by: alessiottavo <93441886+alessiottavo@users.noreply.github.com>
37 lines
1.5 KiB
Plaintext
37 lines
1.5 KiB
Plaintext
---
|
|
slug: documentation-migration
|
|
title: Migration of Documentation
|
|
date: 2022-06-22
|
|
authors:
|
|
- ajnart
|
|
- manuel-rw
|
|
tags: [documentation, migration]
|
|
---
|
|
|
|
We are happy to announce that the documentation of Homarr has been migrated to Docusaurus - An opensource documentation tool.
|
|
The documentation has been re-written partly and includes now many animations, guides and additional crucial information.
|
|
|
|
We are still figuring things out and highly depend on your feedback.
|
|
|
|
{/* Historical excerpt boundary. */}
|
|
|
|
## Why we migrated
|
|
|
|
The default GitHub Wiki feature is decent - but very confusing to read.
|
|
Our possibilites for searching the documentation in the Wiki are highly limited.
|
|
Additionally, Users are unable to contribute to the documentation if they have not sufficient permissions.
|
|
|
|
We could not review any chanegs made to the documentation. This is why we migrated to Docusaurus.
|
|
|
|
## How you can contribute
|
|
|
|
The documentation will soon be merged into the master branch of Homarr.
|
|
You'll find a ``doc/`` directory in the root of Homarr.
|
|
We'll obviously not include this in our Docker images.
|
|
In the future, everyone may modify the documentation by creating a pull request.
|
|
After we've reviewed your changes, we'll merge your PR and this documentation will automatically update.
|
|
|
|
## TL;DR
|
|
|
|
The documentation on GitHub Wiki will soon disappear. It will be replaced with this Docusaurus-powered website. You'll find much more information here with higher detail and searchability.
|