Skip to content

Commit

Permalink
Refactor app documentation and Docker build context for docs directory
Browse files Browse the repository at this point in the history
  • Loading branch information
Robert27 committed Sep 13, 2024
1 parent 1f8faeb commit a8b1e00
Show file tree
Hide file tree
Showing 7 changed files with 50 additions and 50 deletions.
7 changes: 3 additions & 4 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,16 @@ function sidebarApp(): DefaultTheme.SidebarItem[] {
text: "Support",
collapsed: false,
items: [
{ text: "Problems", link: "problems" },
{ text: "Troubleshooting", link: "troubleshoot" },
{ text: "Feedback", link: "feedback" },
{ text: "Contact", link: "contact" },
],
},
{
text: "Contributing",
collapsed: false,
items: [
{ text: "Troubleshooting", link: "troubleshoot" },
{ text: "Feedback", link: "feedback" },
{ text: "Ways to Contribute", link: "contribute" },
{ text: "Setup Development", link: "setup" },
],
},
];
Expand Down
2 changes: 1 addition & 1 deletion docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
);
--vp-home-hero-image-background-image: radial-gradient(
circle,
#0084ff 60%,
#00c8ff 60%,
#0084ff37 50%
);
--vp-home-hero-image-filter: blur(50px);
Expand Down
2 changes: 1 addition & 1 deletion docs/about/contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const members = [
avatar: 'https://github.com/Robert27.png',
name: 'Robert Eggl',
logo: './assets/robert.png',
title: 'Project Lead Neuand Next',
title: 'Founder & Project Lead Neuand Next',
links: [
{ icon: 'github', link: 'https://github.com/Robert27' },
]
Expand Down
29 changes: 29 additions & 0 deletions docs/app/contribute.md
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.
:::
16 changes: 9 additions & 7 deletions docs/app/features.md
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!
42 changes: 6 additions & 36 deletions docs/app/contributing.md → docs/app/setup.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,6 @@
---
layout: doc
outline: [2, 3]
---
# Setup Development Environment

# 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.
:::

## Getting Started for Developers

### Prerequisites
## Prerequisites

1. Fork the repository and clone it to your local machine.
2. Install the required software:
Expand Down Expand Up @@ -76,7 +46,7 @@ Step 7 is required every time the dependencies are updated.

:::

### Development
## Development

1. Create a new branch from your fork to contribute to the project. Use a descriptive branch name.
2. Make your changes and ensure that the code follows our coding style and conventions.
Expand All @@ -88,7 +58,7 @@ Step 7 is required every time the dependencies are updated.

This allows you to run the app one the previously created development build. Expo Go is not supported for development.

### Submitting Changes
## Submitting Changes

1. Commit your changes to your branch. To ensure descriptive commit messages, we recommend using the
[Angular commit message style](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-header) for your commit messages.
Expand All @@ -114,7 +84,7 @@ Step 7 is required every time the dependencies are updated.

:::

### Code Style
## Code Style

- Follow the existing code style and conventions used in the project.
- Use meaningful variable and function names to improve code readability.
Expand All @@ -131,7 +101,7 @@ But you can also run these commands manually:
- `bun lint:fix` to automatically fix linting errors
- `bun format` to format the code using Prettier

### Issues and Discussions
## Issues and Discussions

- Feel free to open an issue if you encounter a bug or want to suggest an improvement.
- For questions or more general concerns, create a thread in the discussion tab.
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"extends": "expo/tsconfig.base",
"baseUrl": ".",
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@/*": ["./src/*"],
"ios/*": ["./ios/NeulandNext/Images.xcassets/*"]
Expand Down

0 comments on commit a8b1e00

Please sign in to comment.