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

Documentation for End Users #47

Closed
SudharakaP opened this issue Jul 18, 2019 · 1 comment
Closed

Documentation for End Users #47

SudharakaP opened this issue Jul 18, 2019 · 1 comment
Assignees
Labels
documentation Documentation change

Comments

@SudharakaP
Copy link
Member

SudharakaP commented Jul 18, 2019

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;

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

@SudharakaP SudharakaP added the documentation Documentation change label Jul 18, 2019
@SudharakaP
Copy link
Member Author

We'll hold this off for the moment; until the site gets more traction. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation change
Projects
None yet
Development

No branches or pull requests

2 participants