Commit ae0d4f0d authored by Kourser's avatar Kourser
Browse files

docs: publish documentation to GitLab Pages (MkDocs Material + CI) 



- Add mkdocs.yml (Material theme, FR) building the user/dev guides from docs/
  into the site; internal app-store notes and image folders excluded.
- Add docs/index.md landing page; drop the now-redundant Home.md.
- Add .gitlab-ci.yml: a `pages` job (Linux, pinned mkdocs/mkdocs-material) that
  builds ./public for GitLab Pages on the default branch; plus a manual,
  macOS-tagged Swift test job.
- Fix FAQ links that pointed outside docs/ (→ repo URLs). Ignore build output.

Site build verified locally with the pinned versions.

Co-Authored-By: default avatarClaude <claude@anthropic.com>
parent ca2495e3

.gitignore

+5 −0
Original line number Diff line number Diff line
@@ -16,3 +16,8 @@ Packages/*/.build/ 


# Local xcodebuild SPM clone cache

.build-spm/



# MkDocs / GitLab Pages build output

/public/

/site/

.venv/

.gitlab-ci.yml

0 → 100644
+30 −0
Original line number Diff line number Diff line 
stages:

  - test

  - deploy



# --- Documentation site → GitLab Pages -------------------------------------

# Builds the MkDocs Material site from docs/ into ./public, which GitLab Pages

# serves. Runs on a Linux runner; no macOS needed.

pages:

  stage: deploy

  image: python:3.12.7-slim

  script:

    - pip install --no-cache-dir mkdocs==1.6.1 mkdocs-material==9.6.9

    - mkdocs build --site-dir public

  artifacts:

    paths:

      - public

  rules:

    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'



# --- Swift package tests ----------------------------------------------------

# Requires a macOS runner with the Swift toolchain (tag `macos`). Left manual so

# the pipeline isn't blocked when no macOS runner is registered.

core-tests:

  stage: test

  tags:

    - macos

  when: manual

  allow_failure: true

  script:

    - swift test --package-path Packages/Core

docs/FAQ.md

+2 −2
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ réécrire *clean-room* permet la licence MIT et une distribution App Store. 


### Est-ce disponible sur l'App Store ?

Pas encore. Le projet est en développement ; il compile et tourne sur iOS, iPadOS et

macOS. Voir la [feuille de route](../ROADMAP.md).

macOS. Voir la [feuille de route](https://git.cythin.eu/Kourser/skingomz-app/-/blob/main/ROADMAP.md).



### Mes données et mots de passe sont-ils en sécurité ?

Les abonnements/épisodes sont stockés **localement** (SQLite). Le mot de passe de
@@ -33,4 +33,4 @@ et les AirPods/CarPlay (via Now Playing). 


### Qu'est-ce qui n'est pas encore fait ?

Validation sur appareil réel et contre un vrai serveur de sync, finitions UI, icône

définitive. Détails dans la [feuille de route](../ROADMAP.md).
 
définitive. Détails dans la [feuille de route](https://git.cythin.eu/Kourser/skingomz-app/-/blob/main/ROADMAP.md).

docs/Home.md

deleted100644 → 0
+0 −18
Original line number Diff line number Diff line 
# Wiki Skingomz



Bienvenue sur la documentation de **Skingomz**, lecteur de podcasts natif pour

iPhone, iPad et Mac.



## Pour les utilisateurs

- [Guide utilisateur](Guide-utilisateur.md) — ajouter, écouter, télécharger, mettre en file

- [Configurer la synchronisation](Synchronisation.md) — Nextcloud & gpodder.net

- [FAQ](FAQ.md)



## Pour les développeurs

- [Architecture](Architecture.md) — modules, flux de données, principe clean-room

- [Développement](Developpement.md) — build, tests, conventions

- [Feuille de route](../ROADMAP.md)

- [Contribuer](../CONTRIBUTING.md)



> Ces pages vivent dans `docs/` du dépôt. Elles peuvent aussi être copiées dans

> l'onglet **Wiki** de GitHub.

docs/index.md

0 → 100644
+25 −0
Original line number Diff line number Diff line 
# Skingomz



**Lecteur de podcasts natif, libre et soigné — pour iPhone, iPad et Mac.**



*« Skingomz » signifie « radio / radiodiffusion » en breton.*



## Documentation



- [Guide utilisateur](Guide-utilisateur.md) — ajouter, écouter, télécharger, file d'attente

- [Configurer la synchronisation](Synchronisation.md) — Nextcloud & gpodder.net

- [Architecture](Architecture.md) · [Développement](Developpement.md)

- [FAQ](FAQ.md)



## Liens



- Code source : [git.cythin.eu/Kourser/skingomz-app](https://git.cythin.eu/Kourser/skingomz-app)

- [Feuille de route](https://git.cythin.eu/Kourser/skingomz-app/-/blob/main/ROADMAP.md)

- [Contribuer](https://git.cythin.eu/Kourser/skingomz-app/-/blob/main/CONTRIBUTING.md)



## Fonctionnalités



- Abonnement RSS par URL, recherche (annuaire Apple Podcasts), import OPML

- Lecture en arrière-plan, commandes écran verrouillé, vitesse réglable (0,8×–2×)

- File d'attente, téléchargement hors-ligne, reprise de lecture (lu / non lu)

- Synchronisation des abonnements et de la progression (Nextcloud / gpodder.net)