Skip to content

Conversation

@LilianBsc
Copy link
Collaborator

The goal here is to build a documentation similar Read the Docs's documentation. The documentation should include pages about the project and any relevant information to aid in its understanding. Additionally, it should contain pages generated from the code's docstrings, allowing it to be continuously updated alongside code changes.

  • Use mkdocs to build a documentation site based on the docs folder and the docstrings in the code.
  • Organize documentation sections and add parts from other branches.
  • Deploy the documentation in the github-pages.
  • Build and deploy the documentation automatically in the CI.

@LilianBsc LilianBsc added documentation Improvements or additions to documentation proposition labels Mar 11, 2025
@marthevienne
Copy link
Collaborator

Salut @LilianBsc, le README a été mis à jour dans le main. J'ai modifié ce que je connais mais il y a certaines parties que je ne maitrise pas, notamment toute la partie Docker. Si tu as des questions, n'hésite pas à les poser sur Slack :)

@rv2931
Copy link
Collaborator

rv2931 commented Mar 21, 2025

Hello
Pour la partie docker le service frontend ne compile toujours pas
Du coup pour info pour build et run j'utilise les scripts avec arguments suivants

  • /docker/build.sh bloom-backend
  • /docker/up.sh bloom-backend

@rv2931
Copy link
Collaborator

rv2931 commented Mar 21, 2025

Hello Pour la partie docker le service frontend ne compile toujours pas Du coup pour info pour build et run j'utilise les scripts avec arguments suivants

* /docker/build.sh bloom-backend

* /docker/up.sh bloom-backend

Correction, pour le build /docker/build.sh bloom-init
Mais je me dis que ça aurait un sens de migrer le code de build vers bloom-backend plutôt que bloom-init qui partagent la même image docker (construite une seule fois)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation proposition

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants