-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor app documentation and Docker build context for docs directory
- Loading branch information
Showing
7 changed files
with
50 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
layout: doc | ||
outline: [2, 3] | ||
--- | ||
|
||
# Contributing to Neuland Next | ||
|
||
Neuland Next is an open-source project and we welcome contributions from the community. Whether you are a developer, designer, or student, you can help us improve the app and make it better for everyone. | ||
|
||
## Reporting issues and feedback | ||
|
||
If you encounter a bug, have a feature request, or need help with the app, please let us know. You can find all support options on our [support page](/app/troubleshoot). | ||
|
||
## Ways to contribute | ||
|
||
### Non-developers | ||
|
||
There are many ways to contribute to Neuland Next. Even if you are not a developer, there are many ways you can help us improve the app: | ||
We are always looking for help with documentation, translations, design, and testing. If you are interested in contributing in any of these areas, please let us know using the contact options on our [feedback page](/app/feedback). | ||
|
||
### Developers | ||
|
||
We use GitHub to manage our codebase and track issues. Please refer the [contributing guidelines](#getting-started) for more information on how to contribute to the project. You can find a list of open [issues](https://github.com/neuland-ingolstadt/neuland.app-native/issues) that you can work on. | ||
|
||
If you are new to open-source or need help with your first contribution, feel free to reach out to us. We are happy to help you get started and guide you through the process. | ||
|
||
::: tip Note | ||
Please not that you need a API Key from the THI to work on the app. This key is not included in the repository for security reasons and we only provide it to trusted contributors and members of Neuland Ingolstadt e.V. | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,37 @@ | ||
# Features | ||
|
||
Neuland offers a variety of features to help you navigate your studies at the Technische Hochschule Ingolstadt. Here are some of the key features: | ||
|
||
### Timetable & Exams | ||
|
||
Your personal timetable from PRIMUSS and your exams at a glance. Choose between a beautiful 3-day view and a list view. | ||
Your **personal timetable** from PRIMUSS and your exams at a glance. Choose between a beautiful 3-day view and a list view. | ||
|
||
### Calendar & Events | ||
|
||
All important semester dates and Campus events in one place. Never miss a deadline or event again. | ||
All important **semester dates** and **campus events** in one place. Never miss a deadline or campus life event again. | ||
|
||
### Profile | ||
|
||
View your grades, print credits and much more information about your studies. | ||
View your **grades**, **print credits** and much more information about your studies. | ||
|
||
### Cafeteria | ||
|
||
Check the cafeteria menu, including prices, allergen and nutritional information with support for personal preferences. Supports the Official Cafeteria, Reimanns, Canisius - Convent and the Cafeteria in Neuburg. | ||
Check the **cafeteria menu**, including **prices, allergen and nutritional information** with support for personal preferences. Supports the Official Cafeteria, Reimanns, Canisius - Convent and the Cafeteria in Neuburg. | ||
|
||
### Campus Map | ||
|
||
Find available rooms, view buildings or explore the university campus. Use our smart suggestions to find nearby rooms between classes. | ||
Find **available rooms**, view buildings or explore the university campus. Use our **smart suggestions** to find nearby rooms between classes. | ||
|
||
### Library | ||
|
||
Reserve a seat directly from the app, or use your library ID to check out and return books at the terminals. | ||
**Reserve a seat** directly from the app, or use your library ID to check out and return books at the terminals. | ||
|
||
### Quick Links | ||
|
||
Access key university platforms such as moodle, PRIMUSS or your webmail with a single tap. | ||
|
||
### THI News | ||
|
||
Stay up to date with the latest news from the THI. | ||
Stay up to date with the **latest news** from the THI. | ||
|
||
And more - regular updates based on feedback are on their way! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters