Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
192 changes: 192 additions & 0 deletions Action_Plan_Updated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
**Action Plan -**

**Group Documentation Repositories Separately**

**Revised Problem & Solution**

**Problem**
The documentation for **OnTrack and Splashkit** is scattered across multiple repositories, making it difficult for new students to find relevant information. There is half the information in one place and half in another, causing fragmentation and confusion. When someone searches for details, they are often forced to deal with similar content across multiple repositories without a complete picture. This ineffective structure hinders accessibility and learning.

**Solution**

1. Instead of creating separate repositories for each project, I propose **consolidating** the documentation into a single, unified repository.
1. This repository can serve as a centralized location for all project information.
1. Within this unified repository, I will -
1. Organize OnTrack and Splashkit documentation into dedicated folders for each project.
1. Include additional OnTrack information (e.g., Tutor Times, Local Setup) currently found in documentation-1.
1. Ensure the structure is clear, accessible, and user-friendly for new students.

**Remove Duplication**

**Problem -**
There are redundant files across repositories and within folders which make the documentation difficult to maintain and confusing for new users. A significant example of this duplication exists between **documentation-1** and **documentation-2**.

1. 90 percent of the content is identical across both repositories
1. The excessive use of index.md files, particularly in the Ontrack documentation, causes unnecessary clutter. While index.md files are useful as entry points for sections, I will evaluate each instance to strike a balance between keeping essential entry points and removing unnecessary additions. This will help streamline the structure without losing valuable navigation points.
1. Unique content such as the Password Guideline in documentation-1 is missing in documentation-2
1. In documentation-1, the **Research & Findings** folder in the **Front End Migration** directory contains two very similar files: Testing\_Decision.md and Testing Decision Process.md. –
1. Both files share 90% of their content, making them largely redundant.
1. The only difference is that Testing Decision Process.md includes an additional conclusion section and provides extra details, such as well-defined steps like npm install and npm test.

![](images/img1.png)![](images/img2.png)

To avoid duplication, **one consolidated file** should be sufficient.

**The only differences between documentation-1 and documentation-2 are as follows.** As I have identified these, we should consider merging the unique content into one file and deleting the other -

1. Password Guideline: Exists in the Company Documentation Team folder in documentation-1 but is missing in documentation-2.

1. Empty index.md Files: documentation-2 contains two empty index.md files, whereas documentation-1 has only one empty index.md file.


**Solution -**
We need to consolidate redundant files and merge the unique content into one repository. This includes –

1. Combining the duplicated content in **documentation-1** and **documentation-2** into a single repository
1. Ensuring unique files like the Password Guideline are included in the consolidated repository
1. Removing unnecessary duplicates like multiple index.md files

Eliminating these redundancies will make the documentation easier to maintain and more efficient to use.

Similarly, the **documentation and documentations** repos have a lot in common. Here are some of the similarities. It is important to note that I have not listed all the duplications, as 90% of the content is duplicated.

![](images/img3.png)

documentation

![](images/img4.png)

documentations

![](images/img5.png)

documentation

![](images/img6.png)

Documentations

**Revised Action Plan - Rename Files and Add Brief Descriptions**

**Problem -**

Many files have **ambiguous or generic names**, making it difficult for new students to understand their purpose. This lack of clarity causes confusion and slows down learning.

1. Repository names like **“doubtfire-astro”** and **“doubtfire-io”** do not clearly indicate their contents.
1. Some repositories have **outdated README files**, which haven't been updated in years.
1. Examples of ambiguous names include files like **Aspose.Words.c1eaed0e...**.
1. Generic names such as **image1.png** provide no context.
1. Files within repositories lack clear project identifiers, making it harder for students to locate relevant documentation.

![](images/img7.png)

![](images/img8.png)



**Solution:**

1. Adopt Snake\_Case Naming Convention -
1. Standardize file names using snake\_case (e.g., courseflow\_dfd\_0.png instead of CourseFlow-DFD-0.png).
1. Snake\_case provides a consistent and easily identifiable structure that everyone can follow.
1. Rename Ambiguous and Generic Files -
1. Replace ambiguous names like Aspose.Words.c1eaed0e... with meaningful names like contribution\_guide.png.
1. Change generic names like image1.png to descriptive names such as project\_dashboard.png.
1. Update Repository Names and Descriptions -
1. Clarify confusing repository names (e.g., “doubtfire-astro”) to indicate what they contain, such as “courseflow-docs”.
1. Add or update repo descriptions to clearly explain their purpose and contents.
1. Conduct a README update process for all OnTrack repositories to ensure they are current and relevant, similar to what was done for Splashkit.
1. Add Brief Descriptions -
1. Include a one-line description for each repository and key file to help new students quickly understand their purpose and context.

**Ensure Consistent Repository Format**

**Problem**
The structure and naming conventions across repositories are inconsistent, making navigation difficult and leading to confusion.

**Solution**
We should unify the structure of all repositories to maintain consistency. This includes –

1. Using consistent naming conventions such as lowercase with hyphens for file names (e.g., courseflow-dfd-0.png)
1. Adding a README.md file to directories like src to explain the folder structure and its purpose

This consistency will make the documentation easier to navigate and maintain.

**OnTrack Onboarding Documentation**

**Problem**
OnTrack lacks clear and accessible **onboarding documentation**, which has caused confusion for new students. This was a significant issue at the beginning of the semester when students struggled to get started due to the absence of centralized guidance.

**Solution**

1. Create comprehensive **OnTrack onboarding documentation** and host it on the **Thoth Tech website** ([thoth-tech.netlify.app](https://thoth-tech.netlify.app/)) for easy access.
1. The onboarding documentation should include
1. **Setup Instructions**: Step-by-step guidance for setting up the OnTrack environment.
1. **Key Resources**: Links to essential tools, guides, and repositories.
1. **Common Issues and Troubleshooting**: Solutions to frequent setup and usage problems.
1. **Quick Start Guide**: A simplified guide to help students quickly understand OnTrack and begin using it.

**Objective**

1. Ensure new students have a **clear entry point** for getting started with OnTrack.
1. Make the onboarding process **streamlined and accessible** via the Thoth Tech website to reduce confusion and frustration.

This addition to the action plan addresses the urgent need for onboarding support and ensures new users can quickly find everything they need to get started.


**Correct All Minor Discrepancies**

**Problem**
There are minor inconsistencies across the documentation that can create confusion and reduce clarity. These issues include mismatched file names, inconsistent endpoint conventions, and duplicated content. For example - There are numerous **empty index.md files** that we must consider deleting

**Solution**
We need to address all documented minor inconsistencies to improve clarity and maintainability. This includes

1. Resolving naming mismatches like **setting.md** vs **"settings"** in the SPIS list
1. We should use lowercase and hyphens for file names (e.g., courseflow-dfd-0.png instead of CourseFlow-DFD-0.png).
1. Aligning duplicated API content, such as those found in tutorials.md and similar files across repositories
1. Deleting empty **index.md** files

By correcting these minor discrepancies, the documentation will become more organized, user-friendly, and easier to maintain, minimizing confusion for new users.


**Further explanation for better clarity**






**






In documentation-1, the **Research & Findings** folder in the **Front End Migration** directory contains two very similar files: Testing\_Decision.md and Testing Decision Process.md.

1. Both files share **90% of their content**, making them largely redundant.
1. The only difference is that Testing Decision Process.md includes an additional **conclusion section** and provides extra details, such as well-defined steps like npm install and npm test.

To avoid duplication, **one consolidated file** should be sufficient.


**Task Submission & Redesign**

**In document-1**

![](images/img9.png)





**In document-2**


![](images/img10.png)

Here again, every folder, sub-file, and the content of all files, except for the two differences mentioned above, are the same. We should consider consolidating them into **one repository** to eliminate redundancy.


25 changes: 25 additions & 0 deletions Arcade Games Bugs and Improvements/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Arcade Games Bugs and Improvements

## Purpose
This directory contains documentation regarding bugs, issues, and suggested improvements for various arcade games. It provides detailed analyses of identified bugs and actionable improvement suggestions to enhance game quality.

## Structure
### 1. `Bugs/`
- **Purpose**: Documents specific bugs found in arcade games.
- **Subdirectories**:
- `car-race/`: Includes issues like the "Car Race Clipping Bug."
- `dxballgame/`: Focuses on bugs like "DXBallGame Controls Bug."
- `pingpong/`: Includes issues like "PingPong Playspace Collision Bug" and "PingPong Paddle Collisions."

### 2. `improvement_suggestions/`
- **Purpose**: Contains suggestions for game enhancements.
- **Files**:
- `below_the_surface_enemy_colors.md`: Suggests changes to the enemy color scheme for better visibility.
- `runner_dash_enemy_movement_changes.md`: Proposes options for enemy movement to balance difficulty and player experience.
- `arcade_game_bug_testing_spike_plan.md`: Details the testing plan for identifying bugs and flaws in arcade games, including timelines and deliverables.

## Notes
- Documentation is organized by game and issue type.
- Follow **snake_case** for all new file and folder names.
- Ensure bugs and improvements are written in clear, actionable language for developers.

File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file not shown.
Binary file modified docs/Courseflow/images/CourseFlow_Analytics_Page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion docs/DreamBig/Backend/SSO.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## Diagram Overview

![Login process SSO in Dream](Images/LoginProcess.png)
![Login process SSO in Dream](Images/login_p
rocess.png)

The SSO integration is completed for Dream Big with its architecture illustrated above. Therefore,
both Dream Big and OnTrack can be logged into using your AAF Deakin credentials.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
**UX Testing Deliverables T1 2023**

1. **UX Testing Report**
[UX-Testing-Report.md](https://github.com/thoth-tech/documentation/files/11507287/UX-Testing-Report.md)
[ux_testing_report.md](https://github.com/thoth-tech/documentation/files/11507287/ux_testing_report.md)
<br/>
2. **UX Evaluation Rubric**
[DreamBig UX Evaluation Rubric.xlsx](https://github.com/thoth-tech/documentation/files/11507289/DreamBig.UX.Evaluation.Rubric.xlsx)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A motion to approve the minutes of previous 24/03/2022 meeting was made Jordan T
# Main motions

- Demo documentation (https://deakin365.sharepoint.com/:w:/r/sites/ThothTech2-
Deployment/Shared%20Documents/Deployment/Documentation/demo%20doc.docx?d=we
Deployment/Shared%20Documents/deployment/Documentation/demo%20doc.docx?d=we
ac1113a086c40aeaaec95ba7a4115be&csf=1&web=1&e=KxDKBz)

```
Expand Down
10 changes: 0 additions & 10 deletions docs/OnTrack/Front End Migration/Migration/readme.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,14 @@ increamenting delay

We will also need to either enable or disable a test.

**Student View** ![StudentView](StudentView.jpg "Student View Design")
**Student View** ![StudentView](student_view.jpg
"Student View Design")

**Unit Chair View** ![UnitChair](UnitChair.jpg "Unit Chair Design")
**Unit Chair View** ![UnitChair](UnitChair.jpg
"Unit Chair Design")

**Data Flow Design** ![DataFlow](DataFlow.jpg "Data Flow Design")
**Data Flow Design** ![DataFlow](data_flow.jpg
"Data Flow Design")

In terms of the changes we will require, we will need a new table in the DB to store the tests.

Expand Down
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 10 additions & 0 deletions docs/OnTrack/front_end_migration/Migration/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Steps For Migration

---

We have **two steps** for migration a component.

## Steps

1. [Create Branch](create_branch_and_initial_migration.md)
2. [Regular Commit](regular_migration_step.md)
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,12 @@ As a junior we suggest that you should:
> If the servers in the docker running into issues, please follow the backup plan -
> [Troubleshooting Docker - Backup for OnTrack](Docker/Troubleshooting_Docker_Backup_for_OnTrack.md)
3. Migration
1. Read [Create Brach and Initial Migration](Migration/Create_Branch_and_Initial_Migration)
1. Read [Create Brach and Initial Migration](migration/create_branch_and_initial_migration)
guideline.
2. Read [Regular Commit](Migration/Regular_Migration_Step.md) guideline.
2. Read [Regular Commit](migration/regular_migration_step.md
) guideline.
4. Testing
1. Read [Unit Test](Testing/Unit_Test.md) guideline.
1. Read [Unit Test](testing/unit_test.md) guideline.
5. Do **report any issue** or questions to the senior or deilvery lead.
6. **Writting docemnts** during the learning process which you found intresting or worth to know.
7. Start to migrate some simple components.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ ought to be.

## What Next?

- Read [Project On-boarding](Project-On-Boarding.md)
- Read [Project On-boarding](project_on_boarding.md)
Original file line number Diff line number Diff line change
Expand Up @@ -171,4 +171,4 @@ check the markdown docment in
- Read 2023 T1 Project Weekly updates, Meeting Minutes and other documents in the project TEAMS
channel.

- Read [Project On-boarding](Project-On-Boarding.md)
- Read [Project On-boarding](project_on_boarding.md)
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# View Task and Submission Redesign Documentation Index

## [T1, 2023 Hand-over Document](2023-T1-Hand-Over-Document.md)
## [T1, 2023 Hand-over Document](2023_t1_hand_over_document.md)

A document created to reflect what has been so far accomplished in the project.

## [T1, 2023 Project Scope Sign Off Document](ProjectScope-SignOff-Document.md)
## [T1, 2023 Project Scope Sign Off Document](project_scope_sign_off_document.md)

A document created to reflect the scope of the project and its deliverables for T1 / 2023.

## [T2, 2022 Hand-over Document](2022-T2-Hand-Over-Document.md)
## [T2, 2022 Hand-over Document](2022_t2_hand_over_document.md)

A document created to be the first document read on the project.

## [Project On-boarding](Project-On-Boarding.md)
## [Project On-boarding](project_on_boarding.md)

A document created to assist with the on-boarding process of new contributors to the Task View and
Submission Redesign project.

## [View Task and Submission Redesign Epic](Epic.md)
## [View Task and Submission Redesign Epic](epic.md)

The epic for the View Task and Submission Redesign project.

## [User Stories and Features](User-Stories-and-Features.md)
## [User Stories and Features](user_stories_and_features.md)

The user stories and the features generated by said user stories.

## [Requirements](Requirements.md)
## [Requirements](requirements.md)

The requirements for the Task View and Submission Redesign project.
Loading