Contrairement au vrai projet, les mémos ne sont pas intégrés à JSDoc, il faut les lire directement en tant que fichiers markdown.
On peut les trouver ici (TODO)
#### Mémos des développeurs
#### Code JS : JSDoc
L'implémentation du framework formel, en particulier la traduction en GraphQL, fait l'objet de "mémos" qu'on peut trouver ici : [`memos/implementation`](./memos/implementation)
### Mémos des développeurs
Des mémos/pense-bêtes pour les développeurs et reviewers se trouvent ici : [`memos/developpeurs`](./memos/developpeurs)
### Code JS : JSDoc
La documentation détaillée du projet se trouve [ici](index.html)(fichier`./doc/index.html`).
Elle doit être préalablement compilée avec [JSDoc](http://usejsdoc.org/index.html), selon le fichier de config idoine (fichier `./jsdoc_config.json` à la racine du projet).
Le script pour faire tourner JSDoc et (re)générer la documentation est : `npm run doc`.
Les fichiers compilés se situent dans `./doc/` avec leurs fichiers image. Par nature de l'outil JSDoc il est facile de documenter en détail des fonctions JS mais plus compliqué de documenter un fichier .js.
A chaque execution JSDoc rajoute les commentaires placés dans chacun des fichiers dans la doc de façon structurée.
**Les lignes qui suivent sont adaptées du README du vrai sigma-backend, au moment du fork. Elles ont pour but de permettre au lecteur de rapidement mettre en place et lancer un sigma-poc en local.**
...
...
@@ -226,13 +237,3 @@ Sigma possède une suite de tests unitaires, déstinés à tester les resolvers
Pour executer les tests, il suffit d'utiliser la commande `npm test`.
Les tests effectués sont tous les fichiers en `*.test.ts`, actuellement [resolvers.test.ts](../test/resolvers/resolvers.test.ts) et [ldap.test.ts](../test/ldap/ldap.test.ts). Les différentes requetes testées sont stockées sous forme de liste dans différents fichiers dans [data/](../test/resolvers/data). Chaque élément contient une requête graphql, et les données qu'elle doit renvoyer. Quand les seed sont modifiées, il faudra modifier les resultats attendus également. Les tests peuvent être créés ou mis à jour en entrant la requête dans graphiql, et en copiant le resultat.
## Documentation
La documentation détaillée du projet se trouve [ici](index.html)(fichier`./doc/index.html`).
Elle doit être préalablement compilée avec [JSDoc](http://usejsdoc.org/index.html), selon le fichier de config idoine (fichier `./jsdoc_config.json` à la racine du projet).
Le script pour faire tourner JSDoc et (ré)générer la documentation est : `npm run doc`.
Les fichiers compilés se situent dans `./doc/` avec leurs fichiers image. Par nature de l'outil JSDoc il est facile de documenter en détail des fonctions .js mais plus compliqué de documenter un fichier.
A chaque execution JSDoc rajoute les commentaires placés dans chacun des fichiers dans la doc de façon structurée. Les notes en Markdown placés dans notes/ sont également rajoutées en tant que tutoriels (voir {@tutorial CONTRIBUTING}).
