Skip to content

Commit

Permalink
Merge pull request #348
Browse files Browse the repository at this point in the history
Update AboutUs page
  • Loading branch information
JJtan2002 authored Nov 12, 2024
2 parents 8306fc3 + e7c5bf5 commit 18eaaea
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 13 deletions.
7 changes: 1 addition & 6 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,12 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
<img src="images/flyingsalsa.png" width="200px">

[[github](https://github.com/flyingsalsa)]
[[portfolio](team/flyingsalsa.md)]

### Zheng Xiangcheng

<img src="images/xczheng0105.png" width="200px">

[[homepage](http://www.comp.nus.edu.sg/~damithch)]
[[github](https://github.com/xczheng0105)]
[[portfolio](team/johndoe.md)]


* Role: Member
Expand All @@ -34,7 +31,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`

<img src="images/chenleiyu.png" width="200px">

[[github](http://github.com/ChenLeiyu)] [[portfolio](team/johndoe.md)]
[[github](http://github.com/ChenLeiyu)]

* Role: Developer

Expand All @@ -43,7 +40,6 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
<img src="images/jjtan2002.png" width="200px">

[[github](http://github.com/JJtan2002)]
[[portfolio](team/JJtan2002.md)]

* Role: Developer
* Responsibilities: finish my equal share of this project
Expand All @@ -53,7 +49,6 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
<img src="images/kitty-001.png" width="200px">

[[github](https://github.com/Kitty-001)]
[[portfolio](team/kitty-001.md)]

* Role: Developer
* Responsibilities: learn skills and try to finish my equal share
10 changes: 4 additions & 6 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -523,7 +523,6 @@ We plan to adjust the overlap detection mechanism in the `findtime` command so t

### Enhanced Error Messaging for FindTime Command

**Current Issue**:
When users enter an incorrect, overnight time format in the `findtime` command, the application currently displays a generic "invalid format" message. This can be unclear for users, as it does not specify that the issue is specifically with the overnight time format.

**Enhancement Plan**:
Expand All @@ -534,7 +533,6 @@ This adjustment will improve usability by providing more informative feedback, a

### Contact Card Title Overflow Handling

**Current Issue**:
Currently, when a contact card contains a title or name with an excessively long string, it extends beyond the available width, which may lead to display issues and poor user experience, especially in narrow or non-optimal window sizes. This issue is unlikely to arise with typical names, but could occur with unusually long titles.

**Enhancement Plan**:
Expand All @@ -549,15 +547,15 @@ This enhancement will prevent titles from overflowing and maintain a clean, cons

## **Appendix: Efforts**

GamerBook Pro Max is a project built on the foundation of the original AddressBook, tailored specifically for gamers and their gaming friends. Our team of five embarked on this project to create an efficient and user-friendly application with advanced functionalities that address the unique needs of gamers. The development of GamerBook Pro Max involved applying principles from CS2103T, including:
GamerBook Pro Max is a project built on the foundation of the original AddressBook, tailored specifically for gamers and their gaming friends. Our team of five embarked on this project to create an efficient and user-friendly application with advanced functionalities that address the unique needs of gamers.

### Difficulty Level:
### Difficulty Level

Adapting from the AddressBook to GamerBook Pro Max presented several challenges. While we retained core functionalities, we needed to significantly customize the app to better serve gamers. This included adding features like preferred game times, favorite games, and stateful command history, as well as implementing a powerful search feature.

The main difficulty lay in the number of advanced features we had to develop and integrate, as each new feature introduced additional complexity. As expected, more features resulted in more potential bugs, making debugging and testing a crucial part of the development process.

### Challenges Faced:
### Challenges Faced

1. **Forking Workflow**:
Using the Forking Workflow allowed us to work on multiple features in parallel, which was vital given the size of the project. However, it also introduced the overhead of managing forks and dealing with frequent merge conflicts, especially as we worked on overlapping components such as the command history and address book state features.
Expand All @@ -571,6 +569,6 @@ The main difficulty lay in the number of advanced features we had to develop and
4. **Design Decisions**:
Making design decisions, such as implementing a robust time scheduling feature for gaming sessions, required balancing the user experience with technical constraints. We also had to consider scalability and future enhancements, which led to some complex decisions around data storage and retrieval.

### Effort Required:
### Effort Required

The effort required to develop GamerBook Pro Max was substantial due to the large number of features we implemented and the inevitable bugs that emerged with each new iteration. The effort to resolve issues and fine-tune the system was greater than if we had stuck to the original AddressBook functionality, but it was necessary to achieve the advanced feature set and quality of user experience we envisioned.
4 changes: 3 additions & 1 deletion docs/_markbind/layouts/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@
* [Documentation, logging, testing, configuration, dev-ops]({{ baseUrl }}/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops)
* [Appendix: Requirements]({{ baseUrl }}/DeveloperGuide.html#appendix-requirements)
* [Appendix: Instructions for manual testing]({{ baseUrl }}/DeveloperGuide.html#appendix-instructions-for-manual-testing)
* [Appendix: Planned Enhancement]({{ baseUrl }}/DeveloperGuide.html#appendix-planned-enhancement)
* [Appendix: Planned Enhancements]({{ baseUrl }}/DeveloperGuide.html#appendix-planned-enhancements)
* [Appendix: Efforts]({{ baseUrl }}/DeveloperGuide.html#efforts)

* [About Us]({{ baseUrl }}/AboutUs.html)
</site-nav>
</div>
Expand Down
Binary file modified docs/images/jjtan2002.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 18eaaea

Please sign in to comment.