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

Refactor / Create new documentation page #1370

Open
carlobortolan opened this issue Aug 30, 2024 · 0 comments
Open

Refactor / Create new documentation page #1370

carlobortolan opened this issue Aug 30, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request Open Source Lab

Comments

@carlobortolan
Copy link
Member

Is your feature request related to a problem? Please describe.
Current tumlive documentation misses some tumlive features, doesn't match the tumlive UI and could benefit of a re-styling and update.

Describe the solution you'd like
A modern, clean and up-to-date documentation (e.g., using something similar to docusaurus) that contains all relevant information and guides for lecturers or new users.
The "new" documentation could also include a section for new developers, that helps setting up and running all tumlive-related services (as the current GitHub README only includes the Main API, DB and Worker).

Describe alternatives you've considered
Cleaning up / updating the current docs.

Additional context

  1. This issue would be worked on as part of the Open Source Lab.
2. Example of how this could look like

image

@carlobortolan carlobortolan added documentation Improvements or additions to documentation enhancement New feature or request Open Source Lab labels Aug 30, 2024
@carlobortolan carlobortolan self-assigned this Aug 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 enhancement New feature or request Open Source Lab
Projects
None yet
Development

No branches or pull requests

1 participant