Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Packaging | Documentation | Internship report] - Create pages documentation #48

Open
2 tasks
garciagenrique opened this issue Jul 25, 2024 · 0 comments
Open
2 tasks
Assignees
Labels
documentation Improvements or additions to documentation priority/critical Needs to be done very soon

Comments

@garciagenrique
Copy link
Member

garciagenrique commented Jul 25, 2024

  • Create pages documentation: Create a wiki page explaining in detail the different components of the extension. For example; which subdirs contains the frontend part, why this folder is organised the way it is, where is the python part.... Basically a mini guide to potential newcomers on how to interact with the extension and its components.
  • Build pages every time a change is applied to the repository so that the documentation is always up to date.
@garciagenrique garciagenrique added documentation Improvements or additions to documentation priority/critical Needs to be done very soon labels Jul 25, 2024
@garciagenrique garciagenrique changed the title [Packaging | Documentation] - Document the project [Packaging | Documentation | Internship report] - Create pages documentation Jul 30, 2024
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 priority/critical Needs to be done very soon
Projects
None yet
Development

No branches or pull requests

2 participants