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

Course flow software design documentation #14

Conversation

cmarktopher
Copy link
Contributor

@cmarktopher cmarktopher commented Nov 19, 2023

Description

This is the software design document for CourseFlow which details all the functional requirements for the MVP.

Type of change

  • Documentation (new)

How Has This Been Tested?

Prettier was run to ensure document is formatted correctly. Application was also run to ensure it looked correctly in the browser.

Testing Checklist

  • Tested in latest Chrome

Checklist

  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have requested a review from Onyedikachi Okorie on the Pull Request

Content here is copied over from my draft word document. This will likely be iterated or and improved in the next few days.
Content for this was already done in a draft word document and copied over.
These diagrams were done already for the draft word documented and simply added to this repo.
Some changes to sub-headings and continued content addition for the functional requirements.
Will need to do some proof-reading and then, it should be good to go for review. I'm leaving ui designs out for now (unless advised otherwise) since the focus is on the backend and will likely need its own document.
This was done based on feedback after the first mentor meeting.
Update to the diagram to reflect the changes of the course map model and its incorporation into the user model.
Copy link

netlify bot commented Nov 19, 2023

Deploy Preview for strong-fairy-c1bde1 ready!

Name Link
🔨 Latest commit 71b86b9
🔍 Latest deploy log https://app.netlify.com/sites/strong-fairy-c1bde1/deploys/656813f589dbe90008050b82
😎 Deploy Preview https://deploy-preview-14--strong-fairy-c1bde1.netlify.app/products/courseflow/documentation/software-design-document
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Kachi-Okorie
Copy link
Contributor

It looks good from a build point of view, Daniel can aapprove

After some feedback, it was decided to have CourseFlow as a feature within OnTrack. This commit includes the required changes to take OnTrack into consideration and also, a new ERD diagram.
@maddernd
Copy link
Collaborator

@Kachi-Okorie Kachi-Okorie self-requested a review November 30, 2023 04:25
@maddernd
Copy link
Collaborator

maddernd commented Dec 5, 2023

@Kachi-Okorie i dont have permissions to approve this one. It needs to be approved though as it looks good.

@Kachi-Okorie Kachi-Okorie merged commit 9deee67 into thoth-tech:main Dec 11, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants