docs(readme): update README for clarity and consistency

- Translated sections from German to English for better accessibility.
- Enhanced the structure by clearly defining the workspace relationship and local development instructions.
- Improved descriptions for Docker setup and deployment processes to ensure users understand the requirements and context.
- Updated links and formatting for consistency throughout the document.

This commit aims to improve the overall clarity and usability of the README documentation.
This commit is contained in:
Marvin
2026-04-10 02:12:06 +02:00
parent 66b8446d19
commit 8d8fda49c4
227 changed files with 498 additions and 2496 deletions

View File

@@ -1,63 +1,74 @@
# gregWiki
Docusaurus-Site für **gregFramework** / Data-Center-Modding: `docusaurus.config.js`, `sidebars.js`, React unter `src/`, Inhalte unter [`docs/`](./docs/). Öffentliche Route-Basis: **`/wiki`**.
Docusaurus site for **gregFramework** / Data Center modding: `docusaurus.config.js`, `sidebars.js`, React under `src/`, content under [`docs/`](./docs/). Published route base path: **`/wiki`**.
| | |
|:---|:---|
| **Im Workspace** | Pfad `gregFramework/gregWiki/`. Überblick: [gregFramework README](../README.md). |
| **Remote** | [`mleem97/gregWiki`](https://github.com/mleem97/gregWiki) |
---
## Lokale Entwicklung
## Part of gregFramework
This directory is part of the **[gregFramework](https://github.com/mleem97/gregFramework)** workspace. Clone sibling repositories side by side so each project lives at `gregFramework/<RepoName>/`. See the workspace [README](https://github.com/mleem97/gregFramework/blob/master/README.md) for the full layout and migration notes.
**Remote:** [`mleem97/gregWiki`](https://github.com/mleem97/gregWiki) — on-disk path: `gregFramework/gregWiki/`.
---
## Local development
```bash
npm install
npm run start
```
Produktions-Build:
Production build:
```bash
npm run build
```
Optional: Legacy-GitHub-Wiki spiegeln — siehe [`docs/getting-started/documentation-layout.md`](./docs/getting-started/documentation-layout.md) und Skripte `wiki:sync` / `wiki:normalize-i18n`.
Optional: mirror the legacy GitHub Wiki — see [`docs/getting-started/documentation-layout.md`](./docs/getting-started/documentation-layout.md) and scripts `wiki:sync` / `wiki:normalize-i18n`.
---
## Deployment (Coolify / CI)
- **Standard-Branch:** `main`für neue Arbeit und PRs.
- **`master`:** kann für ältere Deployments parallel existieren; in Coolify den Branch auf **`main`** stellen, wenn möglich.
- **Default branch:** `main`use this for new work and PRs.
- **`master`:** may still exist for older deployments; in Coolify, set the branch to **`main`** when possible.
### Coolify (Dockerfile) — `/app/package.json` fehlt
### Coolify (Dockerfile) — missing `/app/package.json`
Das Image erwartet **`package.json` im Image-Root `/app`**. Das passt nur, wenn der **Docker-Build-Kontext** dieses Repo (gregWiki) ist — nicht ein übergeordneter Monorepo-Ordner ohne Anpassung.
The image expects **`package.json` at the image root `/app`**. That only works if the **Docker build context** is this repository (gregWiki), not a parent monorepo folder without adjustments.
| Einstellung | Wert |
|-------------|------|
| **Dockerfile** | `Dockerfile` im gregWiki-Root |
| **Base directory** | **`.`**, wenn nur `gregWiki` geklont wird. Liegt gregWiki **neben** gregCore im gleichen Clone, oft **`gregWiki`** als Unterverzeichnis setzen. |
| **Volumina** | Kein leerer Host-Mount über `/app`, der `package.json` verdeckt. |
| Setting | Value |
|---------|--------|
| **Dockerfile** | `Dockerfile` at the gregWiki root |
| **Base directory** | **`.`** when only `gregWiki` is cloned. If gregWiki sits **next to** gregCore in the same clone, often set **`gregWiki`** as the subdirectory. |
| **Volumes** | Do not use an empty host mount over `/app` that hides `package.json`. |
Symptom: `docker-entrypoint: ERROR: /app/package.json not found`falscher Kontext oder Volume.
Symptom: `docker-entrypoint: ERROR: /app/package.json not found`wrong context or volume.
## Docker (lokal)
---
Build-Kontext = **dieses** Repository (Ordner mit `package.json`):
## Docker (local)
Build context = **this** repository (folder that contains `package.json`):
```bash
cd path/to/gregWiki
docker compose up --build
```
Liegt gregWiki in **gregFramework**, alternativ vom Workspace aus:
If gregWiki lives inside **gregFramework**, from the workspace root:
```bash
cd path/to/gregFramework
docker compose -f docker-compose.gregwiki.yml up --build
```
(`docker-compose.gregwiki.yml` setzt `build.context: ./gregWiki`.)
(`docker-compose.gregwiki.yml` sets `build.context: ./gregWiki`.)
## Siehe auch
---
- [gregFramework README](../README.md) — flaches Layout `gregFramework/{RepoName}/`
- Quellcode und Builds: **gregCore**, `gregMod.*`, `gregExt.*` als eigene Repos (nicht nur diese Doku)
## See also
- [gregFramework README](../README.md) — flat layout `gregFramework/{RepoName}/`
- Source code and builds: **gregCore**, **gregMod.*** , **gregExt.*** as separate repositories (not only this documentation)