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.

Sign up for GitHub

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

Jump to bottom

Outline documentation structure #2

Open
15 tasks
RealRichi3 opened this issue Jan 23, 2024 · 0 comments
Open
15 tasks

Outline documentation structure #2

RealRichi3 opened this issue Jan 23, 2024 · 0 comments

Comments

@RealRichi3
Copy link
Member

RealRichi3 commented Jan 23, 2024 •
edited
Loading

Outlined documentation structure, more sections can be added later

Parent Issue #1

  • Introduction / Overview of the project
  • Get started (with easy links)
  • Changelogs
  • Contribution Guide
  • Environment setup
  • Deployment Guide
  • Localization and Translation in Open Innovation lab
  • Tutorials / How to's (Ex: How to add a course)
  • Backend API documentation (doc on inner workings)
    • Folder structure
    • DB Design
    • Authentication / Authorization flow
    • Role Based Access control system
    • [Documentation on Core functionalities (i.e what and how each file/function/service operates)
  • Client App documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@RealRichi3