https://github.com/wuespace/telestion-docs

Documentation for the Telestion project, created using Docusaurus v2
https://github.com/wuespace/telestion-docs

docusaurus docusaurus-v2 docusaurus2 telestion

Last synced: about 2 months ago
JSON representation

Documentation for the Telestion project, created using Docusaurus v2

• Host: GitHub
• URL: https://github.com/wuespace/telestion-docs
• Owner: wuespace
• License: mit
• Created: 2020-07-28T14:23:32.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T12:01:56.000Z (about 1 year ago)
• Last Synced: 2024-05-19T00:18:10.416Z (8 months ago)
• Topics: docusaurus, docusaurus-v2, docusaurus2, telestion
• Language: JavaScript
• Homepage: https://docs.telestion.wuespace.de/
• Size: 14.6 MB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Telestion Docs

[![CI](https://github.com/wuespace/telestion-docs/actions/workflows/ci.yml/badge.svg)](https://github.com/wuespace/telestion-docs/actions/workflows/ci.yml)

[![Build and Deploy](https://github.com/wuespace/telestion-docs/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/wuespace/telestion-docs/actions/workflows/gh-pages.yml)

[![Prettier Auto Fix on main](https://github.com/wuespace/telestion-docs/actions/workflows/prettier-auto-fix.yml/badge.svg)](https://github.com/wuespace/telestion-docs/actions/workflows/prettier-auto-fix.yml)

[![GitHub](https://img.shields.io/github/license/wuespace/telestion-docs)](LICENSE)

[![Twitter Follow](https://img.shields.io/twitter/follow/wuespace?style=social)](https://twitter.com/wuespace)

This repository contains the documentation for the Telestion Project.

[Go to docs page](https://wuespace.github.io/telestion-docs).

_Please note that this **does not** contain technical references for all

Telestion modules. For that, please refer to the individual READMEs and other

resources of the individual modules. Instead, this documentation focuses on more

general documentation of the Telestion project._

## Writer's guide

You can find a guide for writers/contributors to the documentation at

`src/pages/writers-guide.mdx`, or, within the built website, at

`/writers-guide`.

Please familiarize yourself with these guidelines _before_ beginning to write

documentation for the project.

## Templates

The `docs/_templates` folder has templates for the most common types of pages

you need to write to document the project.

These also include tips and tricks (as comments) as well as valuable snippets

relevant to this specific kind of page (for example, a tutorial)

If you feel like any basic templates are lacking, please search through

[this repository's issues](https://github.com/wuespace/telestion-docs/issues)

for a reference to this kind of template. If you don't find any reference to it,

please feel free to open an issue for it yourself.