[WIP] Update onboarding documentation for beginners #15

2026-02-21T19:41:36Z

Copilot commented

2026-02-21 19:41:36 +00:00

(Migrated from github.com)

Thanks for asking me to work on this. I will get started on it and keep this PR's description up to date as I form a plan and make progress.

Original prompt

Mettre à jour la documentation d'entrée pour les débutants : README.md et TUTO4NOOB.md

Contexte :
Le dépôt electron-rare/Kill_LIFE contient un README existant et un fichier TUTO4NOOB.md. Leur contenu actuel est utile mais partiellement narratif/poétique et manque d'un Quick Start actionnable pour les débutants. Nous devons simplifier et clarifier ces deux fichiers, fournir des commandes concrètes de démarrage, rappel des règles de sécurité, et instructions de contribution. Le but est d'améliorer l'onboarding sans modifier d'autres fichiers sensibles (notamment .github/workflows/).

Travail à effectuer (toujours en français) :

Remplacer le contenu de README.md par la version suivante (intégrale) :

# Kill_LIFE 🚀 — Modèle de projet embarqué IA‑natif

Un template agentique pour projets embarqués IA (ESP / STM / Linux), orienté spéc‑first, traçabilité et sécurité. Ce dépôt fournit :
- un kit de specs (RFC2119 + AC) dans `specs/`
- des runbooks et guides dans `docs/`
- du firmware de référence dans `firmware/`
- de l’outillage et des gates dans `tools/`
- du matériel (KiCad) dans `hardware/`

Badges: CI / Licence / Compliance / Evidence Pack / SBOM / Sécurité (voir hrefs dans le repo)

Quick start (pour débutants)
1. Cloner :
   ```bash
   git clone https://github.com/electron-rare/Kill_LIFE.git
   cd Kill_LIFE

Lire le tutoriel débutant :
- TUTO4NOOB.md (guide pas‑à‑pas)
Installer (script d'installation fourni) :
```
./install_kill_life.sh
```
Si le script échoue, voir INSTALL.md (si présent) ou reportez‑vous à docs/.
Vérifier les specs :
```
python tools/validate_specs.py
```
Sortie attendue : exit code 0 et message “OK” (ou équivalent).

Commandes utiles

Lancer les validations de base :
- python tools/validate_specs.py
Voir les docs :
- ls docs et ouvrir docs/README.md
Menu cockpit (si présent) :
- ./tools/cockpit/menu ou bash tools/cockpit/menu

Règles de sécurité et gouvernance (non‑négociables)

NE JAMAIS modifier .github/workflows/ sans accord humain validé.
Ne jamais commiter de secrets (tokens, clés, mots de passe).
Toute automation agentique doit être auditable et rejetée si non‑sanitised.
Respecter la vie privée et la conformité (RGPD) pour les données utilisateurs.

Contribution

Créez une issue (templates dans .github/ISSUE_TEMPLATE/).
Triage : ajoutez prio:*, risk:*, scope:* et un seul type:*.
Pour automatiser un travail, ajoutez le label ai:* approprié (ex: ai:docs, ai:spec, ai:impl) — si vous n’êtes pas sûr, utilisez ai:hold.
Voir docs/workflows/README.md pour le process complet.

Structure rapide

specs/ — spec driven (00_intake → 04_tasks)
docs/ — runbooks, guides, plans
firmware/ — code pour cibles (native / esp / stm)
hardware/ — KiCad / BOM / règles footprints
tools/ — validators, gates, cockpit
openclaw/ — intégration viewer-only (observer)

Vérifier localement (exemples)

# valider les specs
python tools/validate_specs.py

# lister les docs
ls docs | sed -n '1,120p'

Support

Ouvrez une issue avec le tag type:question et prio:low pour demandes non‑urgentes.
Pour contributions sérieuses, suivez le plan dans docs/plans/README.md.

Licence

MIT. Voir licenses/MIT.txt.

Remerciements

Ce template vise à fournir une base reproductible et sécurisée pour développer des systèmes embarqués IA. Contribuez prudemment et respectez les règles de sécurité.


2) Remplacer le contenu de `TUTO4NOOB.md` par la version suivante (intégrale) :

```markdown
# Tutoriel Kill_LIFE — mode ultra‑débutant

Ce guide court vous explique comment démarrer pas à pas, sans jargon.

Avant de commencer — prérequis
- Un système avec bash (Linux / WSL / macOS).
- Git installé.
- Python 3 installé (`python` ou `python3`).
- Un éditeur (VS Code recommandé).

1) Récupérer le dépôt
```bash
git clone https://github.com/electron-rare/Kill_LIFE.git
cd Kill_LIFE

Ouvrir le projet dans VS Code

Lancez code . (si vous utilisez VS Code) ou ouvrez le dossier dans votre éditeur favori.

Installer (script d’automatisation)

# Rendre le script exécutable si nécessaire
chmod +x ./install_kill_life.sh
# Lancer l'installation
./install_kill_life.sh

Que fait ce script ? Il installe les dépendances locales et prépare l’environnement de travail. Si le script n’existe pas ou échoue, consultez INSTALL.md ou docs/ pour les étapes manuelles.

Vérifier que tout va bien (test simple)

# Valide les specs et la configuration de base
python tools/validate_specs.py

Si cette commande affiche une erreur, copiez le message et ouvrez une issue en joignant la sortie.

Où trouver ce que vous cherchez

README.md — vue d’ensemble
docs/ — guides et runbooks
specs/ — exigences obligatoires (RFC2119 + acceptance criteria)
firmware/ — code pour microcontrôleurs et native
tools/ — scripts d’aide (validate, sanitize, cockpit)

Premier diag...

This pull request was created from Copilot chat.

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Thanks for asking me to work on this. I will get started on it and keep this PR's description up to date as I form a plan and make progress.  <details> <summary>Original prompt</summary> Mettre à jour la documentation d'entrée pour les débutants : README.md et TUTO4NOOB.md Contexte : Le dépôt `electron-rare/Kill_LIFE` contient un README existant et un fichier TUTO4NOOB.md. Leur contenu actuel est utile mais partiellement narratif/poétique et manque d'un Quick Start actionnable pour les débutants. Nous devons simplifier et clarifier ces deux fichiers, fournir des commandes concrètes de démarrage, rappel des règles de sécurité, et instructions de contribution. Le but est d'améliorer l'onboarding sans modifier d'autres fichiers sensibles (notamment `.github/workflows/`). Travail à effectuer (toujours en français) : 1) Remplacer le contenu de `README.md` par la version suivante (intégrale) : ```markdown # Kill_LIFE 🚀 — Modèle de projet embarqué IA‑natif Un template agentique pour projets embarqués IA (ESP / STM / Linux), orienté spéc‑first, traçabilité et sécurité. Ce dépôt fournit : - un kit de specs (RFC2119 + AC) dans `specs/` - des runbooks et guides dans `docs/` - du firmware de référence dans `firmware/` - de l’outillage et des gates dans `tools/` - du matériel (KiCad) dans `hardware/` Badges: CI / Licence / Compliance / Evidence Pack / SBOM / Sécurité (voir hrefs dans le repo) Quick start (pour débutants) 1. Cloner : ```bash git clone https://github.com/electron-rare/Kill_LIFE.git cd Kill_LIFE ``` 2. Lire le tutoriel débutant : - `TUTO4NOOB.md` (guide pas‑à‑pas) 3. Installer (script d'installation fourni) : ```bash ./install_kill_life.sh ``` Si le script échoue, voir `INSTALL.md` (si présent) ou reportez‑vous à `docs/`. 4. Vérifier les specs : ```bash python tools/validate_specs.py ``` Sortie attendue : exit code 0 et message “OK” (ou équivalent). Commandes utiles - Lancer les validations de base : - `python tools/validate_specs.py` - Voir les docs : - `ls docs` et ouvrir `docs/README.md` - Menu cockpit (si présent) : - `./tools/cockpit/menu` ou `bash tools/cockpit/menu` Règles de sécurité et gouvernance (non‑négociables) - NE JAMAIS modifier `.github/workflows/` sans accord humain validé. - Ne jamais commiter de secrets (tokens, clés, mots de passe). - Toute automation agentique doit être auditable et rejetée si non‑sanitised. - Respecter la vie privée et la conformité (RGPD) pour les données utilisateurs. Contribution - Créez une issue (templates dans `.github/ISSUE_TEMPLATE/`). - Triage : ajoutez `prio:*`, `risk:*`, `scope:*` et un seul `type:*`. - Pour automatiser un travail, ajoutez le label `ai:*` approprié (ex: `ai:docs`, `ai:spec`, `ai:impl`) — si vous n’êtes pas sûr, utilisez `ai:hold`. - Voir `docs/workflows/README.md` pour le process complet. Structure rapide - specs/ — spec driven (00_intake → 04_tasks) - docs/ — runbooks, guides, plans - firmware/ — code pour cibles (native / esp / stm) - hardware/ — KiCad / BOM / règles footprints - tools/ — validators, gates, cockpit - openclaw/ — intégration viewer-only (observer) Vérifier localement (exemples) ```bash # valider les specs python tools/validate_specs.py # lister les docs ls docs | sed -n '1,120p' ``` Support - Ouvrez une issue avec le tag `type:question` et `prio:low` pour demandes non‑urgentes. - Pour contributions sérieuses, suivez le plan dans `docs/plans/README.md`. Licence - MIT. Voir `licenses/MIT.txt`. Remerciements - Ce template vise à fournir une base reproductible et sécurisée pour développer des systèmes embarqués IA. Contribuez prudemment et respectez les règles de sécurité. ``` 2) Remplacer le contenu de `TUTO4NOOB.md` par la version suivante (intégrale) : ```markdown # Tutoriel Kill_LIFE — mode ultra‑débutant Ce guide court vous explique comment démarrer pas à pas, sans jargon. Avant de commencer — prérequis - Un système avec bash (Linux / WSL / macOS). - Git installé. - Python 3 installé (`python` ou `python3`). - Un éditeur (VS Code recommandé). 1) Récupérer le dépôt ```bash git clone https://github.com/electron-rare/Kill_LIFE.git cd Kill_LIFE ``` 2) Ouvrir le projet dans VS Code - Lancez `code .` (si vous utilisez VS Code) ou ouvrez le dossier dans votre éditeur favori. 3) Installer (script d’automatisation) ```bash # Rendre le script exécutable si nécessaire chmod +x ./install_kill_life.sh # Lancer l'installation ./install_kill_life.sh ``` Que fait ce script ? Il installe les dépendances locales et prépare l’environnement de travail. Si le script n’existe pas ou échoue, consultez `INSTALL.md` ou `docs/` pour les étapes manuelles. 4) Vérifier que tout va bien (test simple) ```bash # Valide les specs et la configuration de base python tools/validate_specs.py ``` Si cette commande affiche une erreur, copiez le message et ouvrez une issue en joignant la sortie. 5) Où trouver ce que vous cherchez - README.md — vue d’ensemble - docs/ — guides et runbooks - specs/ — exigences obligatoires (RFC2119 + acceptance criteria) - firmware/ — code pour microcontrôleurs et native - tools/ — scripts d’aide (validate, sanitize, cockpit) 6) Premier diag... </details>  *This pull request was created from Copilot chat.* >  --- 🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. [Learn more about Advanced Security.](https://gh.io/cca-advanced-security)

👍 1

electron-rare (Migrated from github.com) approved these changes 2026-02-21 19:44:21 +00:00

electron-rare (Migrated from github.com) left a comment

ok

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: electron-rare/Kill_LIFE#15