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

[05/01/2023] Project Documentation #151

Open
RealRichi3 opened this issue Jan 5, 2023 · 4 comments
Open

[05/01/2023] Project Documentation #151

RealRichi3 opened this issue Jan 5, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@RealRichi3
Copy link
Member

Description

This is a sample outline for the MOOC's project documentation

Introduction
Changelog (short preview of the milestones achieved in the project)
Design and architecture
Getting started

  • Prerequisites
  • Installation Guide
  • Usage

Project Folder structure

  • Directory structure
  • Folder functions
  • File naming conventions

Local Environment setup
Contribution Guide/Workflow

  • General Contrbution guides
    - Raising issues
    - Making changes
    - Submittting Pull request
  • Frontend specific contribution guidelines
  • Backend specific contribution guidelines

Code documentation

  • Database model design
  • Function docs
  • API docs

FAQs

@RealRichi3 RealRichi3 added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 5, 2023
@RealRichi3
Copy link
Member Author

@sandygudie @BatoolMM here's a sample outline for the project documentation, please review and make necessary suggestions

@BatoolMM
Copy link
Member

BatoolMM commented Jan 5, 2023

Looks amazing @RealRichi3, just minor changes to the order:

  • Introduction
  • Getting started
    • Prerequisites
    • Installation Guide
    • Usage
  • Changelog (short preview of the milestones achieved in the project)
  • Design and architecture
  • Project Folder structure
    • Directory structure
    • Folder functions
    • File naming conventions
  • Local Environment setup
  • Contribution Guide/Workflow
  • General Contrbution guides
    • Raising issues
    • Making changes
    • Submittting Pull request
  • Frontend specific contribution guidelines
  • Backend specific contribution guidelines
  • Code documentation
  • Database model design
  • Function docs
  • API docs

@RealRichi3
Copy link
Member Author

Thanks @BatoolMM, @sandygudie what do you think?

@sandygudie
Copy link
Member

Thanks @BatoolMM, @sandygudie what do you think?

It’s great

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
Projects
None yet
Development

No branches or pull requests

3 participants