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

Jump to bottom

Improve descriptions on top of each page #109

Open
6 of 7 tasks
NoamGaash opened this issue Oct 11, 2023 · 22 comments
Open
6 of 7 tasks

Improve descriptions on top of each page #109

NoamGaash opened this issue Oct 11, 2023 · 22 comments
Labels
frontend frontend developers issue good first issue Good for newcomers non-code

Comments

@NoamGaash
Copy link
Member

NoamGaash commented Oct 11, 2023 •
edited by zushar

Our users doesn't understand the data shown on different pages.
We will need some text contributions describing what's going on.

The text will need approval - we have volunteers with legal understanding, but it could take more time than other contribution. Yet, this contribution is vital.

ways to contribute -

  1. write the text here - https://docs.google.com/document/d/1jCXtb4T1uNpI8D23p-nAogorb8YVg_dsx0DKZJXj160/edit?usp=sharing
  2. translate/rephrase a text
  3. add text to the code by making a pull request. the text can be inside a <section> tag or inside a <Tooltip> component
  • dashboard page
  • timeline page
  • gaps page
  • gaps_patterns page
  • map page
  • single-line-map page
  • about page

thank you all!
@NoamGaash NoamGaash added the good first issue Good for newcomers label Oct 27, 2023
@NoamGaash NoamGaash pinned this issue Oct 27, 2023
@ArkadiK94
Copy link
Collaborator

A short welcoming description for the dashboard page, using ChatGPT ( If it is ok, I will continue for the other pages as well.)

English:
"Welcome to our platform dedicated to providing accurate bus schedules and real-time departure updates, all to ensure a more reliable and convenient bus service. Users can contribute by reporting issues like late, missed, or non-arriving buses, fostering a community-driven effort towards a better bus travel experience for all."

Hebrew:
"ברוכים הבאים לפלטפורמה שלנו שמטרתה ( החלפתי מ"המקודשת") לספק לוחות זמנים מדויקים של האוטובוסים ועדכוני יציאה בזמן אמת, הכל כדי להבטיח שירות אוטובוסים אמין ונוח יותר. המשתמשים יכולים לתרום על ידי דיווח על בעיות כמו איחורים, נסיעות שלא עצרו או שלא התקיימו, תוך יצירת מאמץ משותף שמטרתו לשפר את חוויית הנסיעה באוטובוס עבור כולם."

Screenshot_20231106_160021_ChatGPT.jpg

@NoamGaash
Copy link
Member Author

This message is very generic, I'm not sure it describe what's seen on this page

@ArkadiK94
Copy link
Collaborator

In my opinion, we should add a welcome page / section in the dashboard so users will know the general purpose of the site. Also, I will do something more specific for what we see in the dashboard. Is it ok that I use chatgpt for that?

@NoamGaash
Copy link
Member Author

Sure, my only concern is the text quality. I want users to understand what they're seeing.
Have you seen the "about" page?

@ArkadiK94
Copy link
Collaborator

English:
"The dashboard, featuring multiple information blocks, allows you to set a time range and access insights on bus operators' success rates in meeting scheduled times, identifying poor-performing operators and bus lines, and viewing charts depicting the percentage of bus operators departing from all scheduled lines for specific days or hours."

Hebrew:
"לוח המחוונים, המכיל מספר קטעי מידע, מאפשר לכם לקבוע טווח זמן ולקבל מידע על אחוזי הצלחה של מפעילים בהתאמה לשעות היציאה המתוזמנות, זיהוי של מפעילים וקווי אוטובוס פחות יעילים, והצגת תרשימים המתארים את אחוזי היציאות של המפעילות אוטובוס המתוזמנים לימים או שעות ספציפיים."

@ArkadiK94
Copy link
Collaborator

ArkadiK94 commented Nov 6, 2023 •
edited

What do you think?
It is for the dashboard, I add here the screen shot from chatgpt.

Screenshot_20231106_164434_ChatGPT.jpg

@ArkadiK94
Copy link
Collaborator

I thought about better approach to solve this issue. Let's make a drive word file in which every one could suggest changes to the texts. I can write the first texts and people could correct them /write better formats. 🤔

@ArkadiK94
Copy link
Collaborator

Sometimes, it is easier to correct someone than writing from start 😁

@NoamGaash
Copy link
Member Author

Feel free to edit
https://docs.google.com/document/d/1jCXtb4T1uNpI8D23p-nAogorb8YVg_dsx0DKZJXj160/edit?usp=sharing

@ArkadiK94 ArkadiK94 self-assigned this Nov 14, 2023
@ArkadiK94
Copy link
Collaborator

@NoamGaash By mistake, I changed the permissions of all users to be able only to comment before I added myself a permission to edit. Could you add only for me the permission to edit?

@NoamGaash
Copy link
Member Author

The document? Anyone can contribute. That's on purpose

@ArkadiK94
Copy link
Collaborator

@NoamGaash Hmm, I would like to share this file in the discord and also it is here in the github. So it is open for scammers to change the text as they wish. I prefer that only few people could edit it and the others will have the permission to add a comment/suggestion.

With that said, If you still want that everyone could edit this file. Please, change back the permissions in the file.

@NoamGaash
Copy link
Member Author

@ArkadiK94 right now, anyone with link can comment.
image
It's a common practice

@ArkadiK94
Copy link
Collaborator

ArkadiK94 commented Nov 26, 2023 •
edited

@NoamGaash By mistake, I changed the permissions of all users to be able only to comment before I added myself a permission to edit. Could you add only for me the permission to edit?

Yup, I did it. Could you add me that I will also be able to edit?

@ArkadiK94 ArkadiK94 added the frontend frontend developers issue label Nov 27, 2023
@ArkadiK94 ArkadiK94 removed their assignment Dec 8, 2023
@shootermv shootermv mentioned this issue Dec 10, 2023
Merged
@shootermv
Copy link
Collaborator

shootermv commented Jan 4, 2024 •
edited

We have a descriptions at almost all pages now...
@NoamGaash is there more things to be done in here?

@NoamGaash
Copy link
Member Author

@shootermv it's not about having description, it's more about what's in the description... phrases like "תפקוד תחבורה ציבורית לפי פרמטרים שונים" doesn't really say anything.

@shootermv
Copy link
Collaborator

@shootermv it's not about having description, it's more about what's in the description... phrases like "תפקוד תחבורה ציבורית לפי פרמטרים שונים" doesn't really say anything.

personally i think it is now better than before (when there was no explanations)
but sure there is certainly a place for improvement...
so, now it is more - make a descriptions of the pages more explanatory task (which requires some other skills than react knowledge), am i right?

@NoamGaash
Copy link
Member Author

That's true,
The issue isn't react. it's about providing information to the user

@NoamGaash NoamGaash changed the title Add descriptions on top of each page improve descriptions on top of each page Jan 9, 2024
@itai-rozen
Copy link
Contributor

ive added some hebrew & english descriptions in the attached google docs. let me know what you think:)

@NoamGaash
Copy link
Member Author

@itai-rozen looks great, let's hope someone will implement it :)

@itai-rozen
Copy link
Contributor

itai-rozen commented Feb 3, 2024 via email

@NoamGaash
Copy link
Member Author

@itai-rozen I believe in incremental improvements - those texts will (most probably) change in the future. Yet, that's a huge step toward better user experience, and implementing that will be great

@itsoriki itsoriki changed the title improve descriptions on top of each page Improve descriptions on top of each page May 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
frontend frontend developers issue good first issue Good for newcomers non-code
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@shootermv @NoamGaash @itai-rozen @ArkadiK94