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

fix linting error #422

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

fix linting error #422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0902b60
fix lint error functional-requirements.md
Ubayed-Bin-Sufian Feb 13, 2025
7522b0a
fix lint error voice.ts
Ubayed-Bin-Sufian Feb 13, 2025
3d5f412
fix lint error DEV.md
Ubayed-Bin-Sufian Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/DEV.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ After you are set-up, the steps you take depend on what you want to do:
## Editor

_All code is just plain text, so it doesn't really matter what you use to edit them._ However,
using modern, feature-rich IDEs/text-editors like [_**Atom**_](https://github.blog/2022-06-08-sunsetting-atom/),
using modern, feature-rich IDEs/text-editors like [_**Atom**_](https://github.blog/news-insights/product-news/sunsetting-atom/),
[_**Brackets**_](https://brackets.io), [_**WebStorm**_](https://www.jetbrains.com/webstorm/),
[_**Sublime Text**_](https://www.sublimetext.com/),
[_**Visual Studio Code**_](https://code.visualstudio.com/), etc. makes life way easier. These come
Expand Down
41 changes: 23 additions & 18 deletions docs/functional-requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,16 @@

## Introduction

This document outlines the **functional requirements** of the web application, detailing the core features and capabilities necessary for its development. Each requirement is carefully structured to enhance usability, flexibility, and efficiency.
This document outlines the **functional requirements** of the web application, detailing the core features
and capabilities necessary for its development. Each requirement is carefully structured to enhance
usability, flexibility, and efficiency.

Additionally, these functional requirements have been **grouped into clusters** based on their intent and purpose. This categorization helps in understanding the relationships between different features, making it easier to plan development, prioritize tasks, and optimize the overall user experience.
Additionally, these functional requirements have been **grouped into clusters** based on their intent
and purpose. This categorization helps in understanding the relationships between different features,
making it easier to plan development, prioritize tasks, and optimize the overall user experience.

The following sections provide a **detailed list of functional requirements** and their respective **clusters** for better organization and clarity.
The following sections provide a **detailed list of functional requirements** and their respective
**clusters** for better organization and clarity.

## Functional Requirements

Expand Down Expand Up @@ -44,18 +49,18 @@ The following sections provide a **detailed list of functional requirements** an

### Clustered Groups

| Grouped Points | Rationale |
|------------------------------|-----------------------------------------------------------------------------|
| **1-6, 18 (Build Programs)** | Construct and organize programs |
| **6, 10 (Artworks)** | Empower users to create and visualize art programmatically. |
| **7, 9, 22, 26, 28 (Bricks)**| Create, modify, categorize, and search bricks. |
| **8, 14, 30 (WS Viewing)** | Adapt the workspace to user preferences for comfort and productivity. |
| **11, 29 (Run Program)** | Run, stop, and run step-by-step through programs |
| **12, 19, 20, 21 (Save)** | Ensure users can save, export, and access projects across formats/devices. |
| **12, 31 (Save/Merge)** | Save, load, merge and create new projects. |
| **13, 23 (Show Info)** | Help users track progress and learn through statistics and guides. |
| **15 (Language)** | Broaden app accessibility for non-English speakers. |
| **16, 17 (CRUD on Bricks)** | CRUD operation to minimize friction from mistakes and streamline editing. |
| **24 (Modes)** | Cater to diverse skill levels with tailored interfaces. |
| **25 (Configurations)** | Allow users to tailor the app to their workflow and hardware. |
| **27 (Text Editor)** | Support both visual and traditional coding preferences. |
| Grouped Points | Rationale |
| ----------------------------- | ---------------------------------------------------------------- |
| **1-6, 18 (Build Programs)** | Construct and organize programs |
| **6, 10 (Artworks)** | Empower users to create and visualize art programmatically. |
| **7, 9, 22, 26, 28 (Bricks)** | Create, modify, categorize, and search bricks. |
| **8, 14, 30 (WS Viewing)** | Adapt the workspace to user preferences for comfort and productivity.|
| **11, 29 (Run Program)** | Run, stop, and run step-by-step through programs |
| **12, 19, 20, 21 (Save)** | Ensure users can save, export, and access projects across formats/devices.|
| **12, 31 (Save/Merge)** | Save, load, merge and create new projects. |
| **13, 23 (Show Info)** | Help users track progress and learn through statistics and guides.|
| **15 (Language)** | Broaden app accessibility for non-English speakers. |
| **16, 17 (CRUD on Bricks)** | CRUD operation to minimize friction from mistakes and streamline editing.|
| **24 (Modes)** | Cater to diverse skill levels with tailored interfaces. |
| **25 (Configurations)** | Allow users to tailor the app to their workflow and hardware. |
| **27 (Text Editor)** | Support both visual and traditional coding preferences. |