Skip to content

steamicc/wiki_steami

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wiki STeaMi

Documentation technique de la carte STeaMi, une carte éducative IoT basée sur un STM32WB55 (MCU principal) et un STM32F103 (interface DAPLink).

Site : wiki.steami.cc

Contenu

Le wiki couvre 5 sections :

Section Description
Vue d'ensemble Architecture générale, pinout
Hardware Blocs fonctionnels (MCU, capteurs, alimentation, audio, etc.)
Pin Mapping Correspondance broches physiques ↔ fonctions
Composants BOM détaillée (CI, passifs, connecteurs, LEDs, etc.)
Requirements Exigences fonctionnelles, environnementales et physiques

Développement local

Prérequis

  • Node.js >= 20

Installation

npm install

Lancer le serveur de développement

npm start

Le site est accessible sur localhost:3000. Les modifications sont rechargées automatiquement.

Build de production

npm run build

Les fichiers statiques sont générés dans build/.

Structure du projet

./
├── docs/                  # Contenu Markdown du wiki
│   ├── overview/          # Vue d'ensemble et pinout
│   ├── hardware/          # Blocs fonctionnels hardware
│   ├── pin-mapping/       # Mapping des broches
│   ├── components/        # BOM et composants
│   └── requirements/      # Exigences techniques
├── src/
│   ├── pages/             # Pages custom (homepage)
│   └── css/               # Styles custom
├── static/img/            # Images et SVG (pinout, etc.)
├── docusaurus.config.js   # Configuration Docusaurus
└── sidebars.js            # Configuration des sidebars

Déploiement

Le site est déployé automatiquement sur GitHub Pages à chaque push sur main via le workflow deploy.yml.

Contribuer

  1. Créer une branche depuis main
  2. Ajouter ou modifier les pages Markdown dans docs/
  3. Vérifier le rendu avec npm start
  4. Ouvrir une Pull Request avec une description du changement

Le déploiement est automatique après merge sur main.

Repos liés

  • micropython-steami-lib — Drivers MicroPython pour les capteurs et périphériques de la carte
  • DAPLink — Firmware du STM32F103 (branche release_letssteam)

Licence

Ce contenu est distribué sous licence CC BY-SA 4.0. Voir le fichier LICENSE pour les détails.

Wiki STeaMi © STeaMi

About

Technical documentation and wiki for STeaMi board

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors