Skip to content

Commit

Permalink
docs: update setup and features documentation, add changelog section
Browse files Browse the repository at this point in the history
  • Loading branch information
Robert27 committed Nov 7, 2024
1 parent 732a7c3 commit b673a42
Show file tree
Hide file tree
Showing 8 changed files with 51 additions and 13 deletions.
Binary file modified docs/bun.lockb
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/de/app/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,7 @@ Greife mit einem Tap auf wichtige Uni-Plattformen wie Moodle, PRIMUSS oder dein
Bleib up-to-date mit den neuesten News von der THI.
\
Und vieles mehr – regelmäßige Updates basierend auf eurem Feedback sind schon in Arbeit!

## Änderungsprotokoll

Jedes Update bringt neue Funktionen, Verbesserungen und Fehlerbehebungen. Schau dir das [Änderungsprotokoll](https://github.com/neuland-ingolstadt/neuland.app-native/blob/main/CHANGELOG.md) auf GitHub an, um eine detaillierte Übersicht über die Änderungen in jeder Version zu erhalten.
21 changes: 15 additions & 6 deletions docs/de/app/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

3. Installiere die benötigten Abhängigkeiten:

- [Node.js](https://nodejs.org/en/) 18 LTS oder höher
- [Node.js](https://nodejs.org/en/) 22 LTS oder höher
- [Bun](https://bun.sh) oder nutze npm, wenn du die Abhängigkeiten nicht änderst
- [Watchman](https://facebook.github.io/watchman/docs/install) (für Linux- oder macOS-Nutzer)

Expand All @@ -33,7 +33,16 @@

- Folge der [offiziellen Anleitung](https://docs.expo.dev/workflow/ios-simulator/), um den iOS-Simulator einzurichten.

7. Erstelle einen Entwicklungsbuild für deine gewünschte Plattform.
7. Kopiere die `.env.local.example` Datei in `.env.local` und fülle die Variablen aus.
\
Siehe die [Hinweise](/app/contribute#entwickler) zum API-Schlüssel.

```env
EXPO_PUBLIC_THI_API_KEY=abc123 // [!code --]
EXPO_PUBLIC_THI_API_KEY=SUPER_SECRET_API_KEY // [!code ++]
```

8. Erstelle einen Entwicklungsbuild für deine gewünschte Plattform.

```sh
bun ios
Expand All @@ -42,7 +51,7 @@

::: warning Hinweis

Schritt 7 ist jedes Mal erforderlich, wenn die Abhängigkeiten aktualisiert werden.
Schritt 8 ist jedes Mal erforderlich, wenn die Abhängigkeiten aktualisiert werden.

:::

Expand All @@ -60,9 +69,9 @@ Dies ermöglicht es dir, die App mit dem zuvor erstellten Entwicklungs-Build aus

## Änderungen commiten

1. Committe deine Änderungen in deinen Branch. Um beschreibende Commit-Nachrichten zu gewährleisten, empfehlen wir die Verwendung des Angular Commit-Nachricht-Stils.
1. Committe deine Änderungen in deinen Branch. Um beschreibende Commit-Nachrichten und das automatische Erstellen des Changelogs zu gewährleisten, empfehlen wir die Verwendung des Angular Commit-Nachricht-Stils.
2. Erstelle einen Pull-Request von deinem Branch zum Develop-Branch dieses Repositories.
3. Gib einen klaren und beschreibenden Titel sowie eine Beschreibung für deine Pull-Request an, welcher die vorgenommenen Änderungen zusammenfasst.
3. Gib einen klaren und beschreibenden Titel sowie eine Beschreibung für deine Pull-Request an, welcher die vorgenommenen Änderungen zusammenfasst. Verwende ebenfalls den Angular Commit-Nachricht-Stil für den Pull-Request-Titel.
4. Sobald dein Pull-Request eingereicht ist, wird unser Team deine Änderungen überprüfen und dir ein Feedback geben und gegebenenfalls weitere Änderungen anfordern.

::: details Details zum Angular Commit-Nachricht-Stil
Expand All @@ -89,7 +98,7 @@ Dies ermöglicht es dir, die App mit dem zuvor erstellten Entwicklungs-Build aus
- Verwende aussagekräftige Variablen- und Funktionsnamen, um die Lesbarkeit des Codes zu verbessern.
- Dokumentiere deinen Code bei Bedarf mit Inline-Kommentaren.

Wir verwenden den **Husky** Git-Hook, um Commits automatisch gemäß den ESLint-Regeln zu korrigieren und sie mit Prettier zu formatieren.
Wir verwenden den **Husky** Git-Hook, um Commits automatisch gemäß den ESLint-Regeln zu korrigieren, sie mit Prettier zu formatieren und den Commit-Nachrichten-Stil zu überprüfen.
Du kannst diese Befehle aber auch manuell ausführen:

- `bun lint` um nach Linting-Fehlern zu suchen
Expand Down
6 changes: 6 additions & 0 deletions docs/de/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,25 @@ features:
- title: Stundenplan & Prüfungen
icon: 📆
details: Dein persönlicher Stundenplan aus PRIMUSS und deine Prüfungen auf einen Blick.
link: /app/features#stundenplan-prufungen
- title: Kalender & Events
icon: 🎉
details: Alle wichtigen Semestertermine, Campus-Events und Hochschulsport an einem Ort. Verpasse nie wieder eine Frist oder ein Event.
link: /app/features#kalender-events
- title: Profil
icon: 👤
details: Sieh dir deine Noten an, prüfe dein Druckerguthaben und erfahre vieles mehr über dein Studium.
link: /app/features#profil
- title: Mensa
icon: 🍽
details: Schau dir den Speiseplan der Mensa an, inklusive Allergie- und Nährwertinformationen sowie persönlicher Vorlieben.
link: /app/features#mensa
- title: Campusplan
icon: 🗺
details: Finde verfügbare Räume und erkunde den Campus mit intelligenten Vorschlägen und integrierter Suche.
link: /app/features#campusplan
- title: Bibliothek
icon: 📚
details: Reserviere einen Platz direkt in der App oder nutze deinen Bibliotheksausweis, um Bücher an den Terminals auszuleihen.
link: /app/features#bibliothek
---
4 changes: 4 additions & 0 deletions docs/en/app/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,7 @@ Access key university platforms such as moodle, PRIMUSS or your webmail with a s
Stay up to date with the **latest news** from the THI.
\
And more - regular updates based on feedback are on their way!

## Changelog

Each update brings new features, improvements and bug fixes. Check out the [change log](https://github.com/neuland-ingolstadt/neuland.app-native/blob/main/CHANGELOG.md) on GitHub for a detailed overview of the changes in each version.
21 changes: 15 additions & 6 deletions docs/en/app/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

3. Install the required dependencies:

- [Node.js](https://nodejs.org/en/) 18 LTS or higher
- [Node.js](https://nodejs.org/en/) 22 LTS or higher
- [Bun](https://bun.sh) or use npm if you dont't change dependencies
- [Watchman](https://facebook.github.io/watchman/docs/install) (for Linux or macOS users)

Expand All @@ -33,7 +33,16 @@

- Follow the [official guide](https://docs.expo.dev/workflow/ios-simulator/) to set up the iOS simulator.

7. Create a development build for your desired platform.
7. Copy the `.env.local.example` file to `.env.local` and fill in the variables.
\
See the [notes](/app/contribute#developer) on the API key.

```env
EXPO_PUBLIC_THI_API_KEY=abc123 // [!code --]
EXPO_PUBLIC_THI_API_KEY=SUPER_SECRET_API_KEY // [!code ++]
```

8. Create a development build for your desired platform.

```sh
bun ios
Expand All @@ -42,7 +51,7 @@

::: warning Note

Step 7 is required every time the dependencies are updated.
Step 8 is required every time the dependencies are updated.

:::

Expand All @@ -60,9 +69,9 @@ Step 7 is required every time the dependencies are updated.

## Submitting Changes

1. Commit your changes to your branch. To ensure descriptive commit messages, we recommend using the Angular commit message style for your commit messages.
1. Commit your changes to your branch. To ensure descriptive commit messages and automatic changelog generation, we require using the Angular commit message style for your commit messages.
2. Create a pull request from your branch to the develop branch of this repository.
3. Provide a clear and descriptive title and description for your pull request, summarizing the changes you made.
3. Provide a clear and descriptive title and description for your pull request, summarizing the changes you made. Also make sure use the Angular commit message style for the pull request title.
4. Once your pull request is submitted, our team will review your changes and provide feedback or request further modifications if needed.

::: details Details on the Angular commit message style
Expand Down Expand Up @@ -93,7 +102,7 @@ Step 7 is required every time the dependencies are updated.
- Use meaningful variable and function names to improve code readability.
- Document your code when necessary using inline comments.

We use the **Husky** git hook to automatically fix commits according to ESLint rules and format them using Prettier.
We use the **Husky** git hook to automatically fix commits according to ESLint rules, format them using Prettier and to enforce the commit message style.
But you can also run these commands manually:

- `bun lint` to check for linting errors
Expand Down
6 changes: 6 additions & 0 deletions docs/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,25 @@ features:
- title: Timetable & Exams
icon: 📆
details: Your personal timetable from PRIMUSS and your exams at a glance.
link: /en/app/features#timetable-exams
- title: Calendar & Events
icon: 🎉
details: All important semester dates, Campus events and university sports in one place. Never miss a deadline or event again.
link: /en/app/features#calendar-events
- title: Profile
icon: 👤
details: View your grades, printer credits and much more information about your studies.
link: /en/app/features#profile
- title: Cafeteria
icon: 🍽
details: Check the cafeteria menu, including allergen and nutritional information as well as personal preferences.
link: /en/app/features#cafeteria
- title: Campus Map
icon: 🗺
details: Find available rooms and explore the campus with smart suggestions and integrated search.
link: /en/app/features#campus-map
- title: Library
icon: 📚
details: Reserve a seat directly from the app, or use your library ID to check out at the terminals.
link: /en/app/features#library
---
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
"devDependencies": {
"prettier": "3.3.3",
"vitepress": "^1.4.1"
"vitepress": "^1.5.0"
},
"scripts": {
"docs:dev": "vitepress dev",
Expand Down

0 comments on commit b673a42

Please sign in to comment.