Cli doc

[tmarcuzz]

Change description

Add cli documentation to the online documentation.

Type of change

Documentation

• Bug fix (fixes an issue)
• New feature (adds functionality)

Related issues

Checklists

Development

• Lint rules pass locally
• Application changes have been tested thoroughly
• Automated tests covering modified code pass

Security

• Security impact of change has been considered
• Code follows company security practices and guidelines

Code review

• Pull request has a descriptive title and context useful to a reviewer. Screenshots or screencasts are attached as necessary
• reviewers assigned

[louisdussarps]

Quasi bon pour moi.

• j'aurais plus mis la cli comme l'option 1 et le lancement via tsx comme l'option 2
• ça me paraîtrait bien de rajouter mention de la cli :
  • dans le quickstart de la documentation "docusaurus"
  • dans les guides au sein de la documentation "docusaurus"
• et la PR peut être l'occasion d'ajouter la méthode de lancement via le plugin npm que t'utilises en local pour simuler une bdd mongo, peut-être plus dans les options d'installation pour debuging local

[louisdussarps]

j'aurais plus fait une page par commande comme le fait AWS, non ?

[tmarcuzz]

Ça ferait des pages très vides

[louisdussarps]

on peut garder ça dans build mais pas forcément dans "start" pour pouvoir continuer à lancer la doc facilement.
Sinon la partie tsdoc est décrite et générée via un plugin docusaurus - mais sans doute trop compliqué pour la cli en effet

[tmarcuzz]

lancer la doc facilement

Est-ce vraiment moins facile ? C'est toujours la même commande, et une quinzaine de secondes en plus à tout casser. Au contraire, si tu ne mets pas le build:cli dans le start et que tu n'as jamais buildé la doc de la cli bah ça plante.

[louisdussarps]

Oui c'est moins facile, surtout dans le cas où je stoppe mon docusaurus et le relance en suivant.

Globalement c'est aussi ce que font les autres plugins, dont le plugin "typedoc" : il se compile au moment du build. Et par contre si le dossier "api" n'est pas là, le docusaurus ne plante pas.
En fait la méthode idoine ça serait de mettre la cli comme un plugin dans typedoc - on a déjà un plugin custom webflowIntegrationPlugin. Mais si on peut pas le faire, l'autre option, ça serait de garder le build de la cli le plus discret et économique possible