You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Creating a upto date documentation for end users of the application.
The aim here is to create and keep this documentation upto date so that any user such as a teacher or a student (mainly instructors who might join or use our platform or codebase) to be able to easily find out how to manage their courses, watch lectures etc. This should be an ongoing documentation which will be updated from time to time when new features are added or modified. Maybe the things that needs to be added here are few, but as time passes and we add more features to this the documentation should be the goto place for everything from the end users perspective.
Some things that might need to be documented initially are;
For Instructors/admins (currently we only have admins; refer #33)
How to add courses, chapters, videos etc
How to review comments, replies
For Students
Watch, comment, subscribe and donation options
Describe the solution you'd like
I suggest using Github Pages for this since Github has inbuilt support for this.
Describe alternatives you've considered
We can also use Github Wiki pages but I think Github Pages is a better fit since this is for end users.
Additional context
Open to suggestions or discussions. Some useful links to Github Pages;
Is your feature request related to a problem? Please describe.
Creating a upto date documentation for end users of the application.
The aim here is to create and keep this documentation upto date so that any user such as a teacher or a student (mainly instructors who might join or use our platform or codebase) to be able to easily find out how to manage their courses, watch lectures etc. This should be an ongoing documentation which will be updated from time to time when new features are added or modified. Maybe the things that needs to be added here are few, but as time passes and we add more features to this the documentation should be the goto place for everything from the end users perspective.
Some things that might need to be documented initially are;
For Instructors/admins (currently we only have admins; refer #33)
For Students
Describe the solution you'd like
I suggest using Github Pages for this since Github has inbuilt support for this.
Describe alternatives you've considered
We can also use Github Wiki pages but I think Github Pages is a better fit since this is for end users.
Additional context
Open to suggestions or discussions. Some useful links to Github Pages;
https://help.github.com/en/categories/github-pages-basics
I would prefer we create a seperate gh-pages branch for documentation;
https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages#enabling-github-pages-to-publish-your-site-from-master-or-gh-pages
The text was updated successfully, but these errors were encountered: