From 7057c33779982a74863c7167441ac758ceb7c5fb Mon Sep 17 00:00:00 2001 From: dkanada Date: Thu, 13 Jun 2019 00:09:50 -0700 Subject: [PATCH] layout changes and a small css tweak to hide the subnav --- README.md | 29 ++++++++++++++++----------- docs/contributor-docs/coding-style.md | 6 ------ docs/contributor-docs/contributing.md | 20 +++++++++--------- docs/static/overrides.css | 4 ++++ mkdocs.yml | 3 +-- 5 files changed, 31 insertions(+), 31 deletions(-) delete mode 100644 docs/contributor-docs/coding-style.md diff --git a/README.md b/README.md index 74880aa8c..12360fa1d 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,28 @@ -# Jellyfin project documentation +

Jellyfin Documentation

+

Part of the Jellyfin Project

-This repository houses the Jellyfin project documentation, written for `mkdocs` format in Markdown. PRs welcome. +

+This repository houses all documentation for Jellyfin available at readthedocs and written in markdown. +

-Find it at https://jellyfin.readthedocs.io +## Layout -## Documentation Layout +### Administrators -### User docs +Should be used for documentation related to advanced server setup including non-default configs for more advanced users. -Should be used for documentation related to building, installing, setup, and running the app as a general user. +### Contributors -### Administrator docs +Should be used for documentation related to development, translations, releases, and other ways to contribute to the project. -Should be used for documentation related to advanced server setup including non-default configs for more advanced users. +### Media + +Naming conventions for all supported media types, such as movies or podcasts. -### Developer docs +### Server -Should be used for documentation related to contributing to Jellyfin. +Any documentation related to managing the server or explaining certain features. -### API docs +### API -[future] Should be used for documentation related to the APIs Jellyfin exposes. +Describe all available API endpoints for clients. diff --git a/docs/contributor-docs/coding-style.md b/docs/contributor-docs/coding-style.md deleted file mode 100644 index 37d6e1d62..000000000 --- a/docs/contributor-docs/coding-style.md +++ /dev/null @@ -1,6 +0,0 @@ -# Jellyfin Code Style Guide - -## General style - -* Ensure all new files start with the `new-file-header.txt` file in the root of the repository; this ensures all files are explicitly licensed. - diff --git a/docs/contributor-docs/contributing.md b/docs/contributor-docs/contributing.md index f25f33916..3b80d05f3 100644 --- a/docs/contributor-docs/contributing.md +++ b/docs/contributor-docs/contributing.md @@ -2,30 +2,28 @@ Thank you for your interest in contributing to the Jellyfin project! This page and its children desribe the ways you can contribute, as well as some of our policies. This should help guide you through your first Issue or PR. +Even if you can't contribute code, you can still help Jellyfin! The two main things you can help with are testing and creating Issues, and contributing to documentation, translations, and other non-code components. + ## Issues We use GitHub Issues extensively to track open problems, new enhancements or features, and other aspects of the development of Jellyfin. Please see the [getting help](/user-docs/getting-help) page for help with troubleshooting and finding bugs, and the [documentation on Issues](/contributor-docs/issues) for more information on how to submit good Issues. -## Contributing Code to Jellyfin +## Code -The Jellyfin project consists of a C# core server, a Javascript-based UI, and a number of client applications written in various languages and frameworks. If you have experience with these languages, we're always grateful for any contributions you might want to make! +The entire project consists of a C# core server, a Javascript web client, and a number of other clients written in various languages and frameworks. If you have experience with these languages, we're always grateful for any contributions you might want to make! For general guidelines on how the project works, including how to set up your development copy, make changes, and guidelines on Pull Requests (PRs), please see the [documentation on contributing code](/contributor-docs/contributing-code). Jellyfin follows a "fork and PR" methodology; if you're not familiar with this, please see the [relevant section](/contributor-docs/contributing-code#set-up-your-copy-of-the-repo). -## Other Contributions to Jellyfin - -Even if you can't contribute code, you can still help Jellyfin! The two main things you can help with are testing and creating Issues, and contributing to documentation, translations, and other non-code components. - -### Documentation +## Documentation -Documentation is incredibly helpful! All these docs are written using `mkdocs` via [readthedocs.io](https://readthedocs.io). You can find the raw markdown in the [Jellyfin documentation repository](https://github.com/jellyfin/jellyfin-docs). Pull requests are welcome! +Documentation is incredibly helpful! All these docs are written using `mkdocs` via [readthedocs.io](https://readthedocs.io). You can find the raw markdown in the [documentation repository](https://github.com/jellyfin/jellyfin-docs). Pull requests are welcome! -### Translations +## Translations If you're interested in helping to translate Jellyfin into your local language, we use [Weblate](https://weblate.org/en/) running at [translate.jellyfin.org](https://translate.jellyfin.org) to handle translations. These are collected in the `translations` branchs of the various repositories and are merged into the `master` branches before each release. -### Testing +## Testing -Testing is the easiest way to contribute. Simply use Jellyfin, and if you run into problems, [let us know](/user-docs/getting-help). This is the most common way we uncover bugs, through a user doing something we hadn't thought of. If the issue does end up being related to the code, a [bug issue](/contributor-docs/issues#reporting-bugs) can then be opened. +Testing is the easiest way to contribute. Simply use Jellyfin, and if you run into problems, [let us know](/user-docs/getting-help). This is the most common way we uncover bugs, through a user doing something we hadn't thought about. If the issue does end up being related to the code, a [bug issue](/contributor-docs/issues#reporting-bugs) can then be opened. diff --git a/docs/static/overrides.css b/docs/static/overrides.css index ae6198c84..828d2cc0d 100644 --- a/docs/static/overrides.css +++ b/docs/static/overrides.css @@ -22,3 +22,7 @@ border-top: none; border-bottom: none; } + +.subnav { + display: none; +} diff --git a/mkdocs.yml b/mkdocs.yml index 6d2cb3ee9..fdfdd9985 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,10 +20,9 @@ pages: - Contributors: - Contributing: 'contributor-docs/contributing.md' - GitHub Issues: 'contributor-docs/issues.md' - - Development Procedure: 'contributor-docs/contributing-code.md' + - Development: 'contributor-docs/contributing-code.md' - Branding: 'contributor-docs/branding-guide.md' - Release Procedure: 'contributor-docs/release-procedure.md' - - Style Guidelines: 'contributor-docs/coding-style.md' - Media: - Movies: 'media/movies.md' - Music: 'media/music.md'