mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-06-04 08:49:59 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: restructure

Browse source
This commit is contained in:
Erik Michelson 2025-02-11 18:00:04 +01:00 • committed by Erik Michelson
parent 91ebd519a8
commit 70a6583fe0
No known key found for this signature in database
GPG key ID: DB99ADDDC5C0AF82
69 changed files with 471 additions and 385 deletions
Download patch file Download diff file Expand all files Collapse all files

47
docs/content/index.md
View file

@ -19,9 +19,9 @@ that you can host yourself.
<!-- markdownlint-disable proper-names -->
<!-- TODO: HedgeDoc Tour Video https://github.com/hedgedoc/hedgedoc/issues/4828 -->
<!-- markdownlint-enable proper-names -->
- 🦔 New to HedgeDoc? Take the [HedgeDoc tour][hedgedoc-tour]
- 🚀 Want your own instance? [Install HedgeDoc yourself][install-guide]
- 🛠️ Want to change something about HedgeDoc? Read the [Configuration reference][config-reference]
- 🦔 New to HedgeDoc? Watch the [HedgeDoc tour video][hedgedoc-tour].
- 🚀 Want your own instance? [Install HedgeDoc yourself][install-guide].
- 🛠️ Want to change something about HedgeDoc? Read the [Configuration reference][config-reference].
## Getting help
@ -37,42 +37,47 @@ Having trouble? We’d like to help!
To make it easy for you to find the relevant documentation articles, we organized our docs by the
following categories:
- **[Tutorials][tutorials]** are detailed step-by-step instructions. Start here if you're new to
HedgeDoc, want to create your first presentation or want to build a simple API application.
- **[How-to guides][how-to]** target the more advanced users and guide them through a variety of
topics, addressing non-trivial use-cases. They are more advanced than tutorials and assume some
knowledge of HedgeDoc.
- **[Core concepts][core-concepts]** explain the internal structure of HedgeDoc by providing
background information and explanations. They are especially useful for contributing to HedgeDoc.
- **[References][references]** are details to lookup in a non-guided way. These include for example
configuration options or API methods.
- **[Getting started][tutorials]:** This section contains tutorials for people who are new to
HedgeDoc. Start here to learn how to create your first note or presentation, how to manage your
notes or even how to setup your own instance.
- **[How-to guides][how-to]:** This section targets the more advanced users. It guides you through
a variety of topics, addressing non-trivial use-cases. The guides are more advanced than tutorials
and assume some knowledge of HedgeDoc.
- **[Configuration][config-reference]:** All configuration options are explained in this section.
Use it as a reference when setting up your own instance or explore the possibilities what can be
configured.
- **[Development][development]:** This section contains explanations of the core concepts behind
the architecture of HedgeDoc as well as guides to set up the development environment for
ontributing to the codebase. Use this section as a starting point if you intend to contribute
code-wise to HedgeDoc.
- **[References][references]:** This section contains information that is useful to look up in a
non-guided way. This includes for example the supported Markdown features or the API endpoints.
## Participate in the HedgeDoc project
There are different ways how you can participate in the HedgeDoc project:
- Help others or share your experiences and tips in the [community forum][community-forum].
- Improve the translation HegdeDoc of HedgeDoc into your language at our [weblate][weblate].
- Improve the translation of HedgeDoc into your language at our [translation tool][weblate].
- Report bugs, feature requests or enhancement ideas in our [issue tracker][issue-tracker].
- Read the [getting started how-to for developers][how-to-dev] to start implementing
your own features.
- Read the [development section][development] of the docs to setup your local dev environment and
start implementing your own features.
[![Deployed using netlify](https://www.netlify.com/img/global/badges/netlify-color-accent.svg)
](https://www.netlify.com)
[hedgedoc-tour]: https://tour.hedgedoc.org
[install-guide]: tutorials/setup.md
[config-reference]: references/config/index.md
[install-guide]: getting-started/setup.md
[config-reference]: config/index.md
[faq]: faq/index.md
[community-forum]: https://community.hedgedoc.org/
[chat]: https://chat.hedgedoc.org
[issue-tracker]: https://github.com/hedgedoc/hedgedoc/issues/new/choose
[tutorials]: tutorials/index.md
[how-to]: how-to/index.md
[core-concepts]: concepts/index.md
[tutorials]: getting-started/index.md
[how-to]: guides/index.md
[development]: development/index.md
[references]: references/index.md
[weblate]: https://translate.hedgedoc.org
[how-to-dev]: how-to/develop/setup.md