Feature/issue 210/improve documentation#235
Merged
GerardChabaBristol merged 46 commits intodevfrom Apr 3, 2025
Merged
Conversation
Created a diagrams folder in our docs, to store all our diagrams in order to make our docs folder cleaner.
…hub.com/spe-uob/2024-AILearningTool into feature/issue-210/Improve-documentation
Created a basic handover document which will be updated.
fixed issue where architecture diagram did not load correctly
Fixed diagram file pathes to point to new correct path.
added table of contents to handover document
Added list of team members to handover documents
…hub.com/spe-uob/2024-AILearningTool into feature/issue-210/Improve-documentation
yi23484
requested review from
GerardChabaBristol,
Liuwf4319,
RainBOY-ZZX,
Siyuan106 and
vladislav-k1
Contributor
|
I would keep this open for now, as we are still coding stuff |
GerardChabaBristol
requested changes
Apr 1, 2025
Collaborator
GerardChabaBristol
left a comment
GerardChabaBristol
left a comment
There was a problem hiding this comment.
Could you update the architecture diagram in the handover document to the new diagram (we're not using MariaDB).
Expanded on project structure.
Updated drawio diagram to use SQLite instead of MariaDB
deleted old architecture diagram
deleted old architecture diagram
yi23484
added
Github
This was referenced Apr 2, 2025
…spe-uob/2024-AILearningTool into feature/issue-210/Improve-documentation
Updated Setup instructions and expanded on frontend file descriptions.
vladislav-k1
approved these changes
Apr 3, 2025
Contributor
vladislav-k1
left a comment
vladislav-k1
left a comment
There was a problem hiding this comment.
Everything makes sense. Good work.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue(s):
#210
Type of change: (choose required ones)
Description:
Organised docs folder and added files that should have been there, also created handover document.
Additional context:
Our documentation was seriously lacking and disorganised, these changes should fix that issue.
Testing instructions:
N/A.