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.

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

AquaNet UX fixes #118

Open
wants to merge 14 commits into
base: v1-dev
Choose a base branch
from
Open

AquaNet UX fixes #118

wants to merge 14 commits into from

Conversation

raymonable
Copy link
Contributor

@raymonable raymonable commented Feb 27, 2025

As it's unlikely that AquaNet2 will be finished and on production any time soon, I figured I'd add some QoL features to AquaNet.

Changes:

  • Added textarea in place of bio in settings
  • Removed location settings

image

  • Added bio to profile page
  • Added more details for usernames (makes use of display name if set, no longer totally useless)

image

  • Update fonts on AquaBox userplate
  • AquaBox: Added new DDS textures and rating colors to match

image

  • Moved navigation bar strings to i18n
  • Add announcement (located in config.ts. Might want to find an efficient way to set it remotely?)

image

  • Automatically select the latest game when opening your profile
  • Added tooltip to navigation bar for profile for clarity

TODO:

  • Add Chinese translations for navigation bar?
  • Add image for AquaBox?

好的,这是翻译成中文的 pull request 总结:

Sourcery 总结

此 pull request 引入了多项 AquaNet 的用户体验改进,包括用于用户简介的文本区域、个人资料页面上的简介部分、改进的用户名显示、公告功能、自动游戏选择以及个人资料图标的工具提示。 它还包括字体更新和导航字符串的国际化。

新功能:

  • 在设置中添加一个用于用户简介的文本区域,允许更长和更详细的描述。
  • 在个人资料页面添加一个简介部分,以显示用户的简介。
  • 添加公告功能,向用户显示重要消息,可通过 config.ts 进行配置。
  • 打开用户个人资料时自动选择最新游戏,以改善用户体验。
  • 为导航栏个人资料图标添加工具提示,以提高清晰度。

增强功能:

  • 通过使用显示名称(如果已设置)来改进个人资料页面上用户名的显示,并在括号中包含用户名。
  • 将导航栏字符串移动到 i18n 以获得更好的国际化支持。
  • 更新 AquaBox 用户面板上的字体,以获得更好的用户体验。
Original summary in English

Summary by Sourcery

This pull request introduces several user experience improvements to AquaNet, including a textarea for user bios, a bio section on the profile page, improved username display, an announcement feature, automatic game selection, and a tooltip for the profile icon. It also includes font updates and internationalization of navigation strings.

New Features:

  • Add a textarea for the user bio in settings, allowing for longer and more detailed descriptions.
  • Add a bio section to the profile page to display the user's bio.
  • Add an announcement feature to display important messages to users, configurable via config.ts.
  • Automatically select the latest game when opening a user's profile to improve user experience.
  • Add a tooltip to the navigation bar profile icon for clarity.

Enhancements:

  • Improve the display of usernames on profile pages by utilizing the display name if it is set, and include the username in parenthesis.
  • Move navigation bar strings to i18n for better internationalization support.
  • Update fonts on AquaBox userplate for a better user experience.

adds display name (if available), moves game name (if display name is visible) and shows username (if available)
i lied about cfvhoco cooky but it's so funny we really needt o do that at some point
changed font to Gothic A1, added new DDS to userbox (all users wishing to benefit MUST update aquabox), added rating numbers
this needs more testing
Copy link
Contributor

sourcery-ai bot commented Feb 27, 2025

## Sourcery 审查者指南

此 Pull Request 为 AquaNet 引入了多项质量改进,包括用户简介的文本区域、增强的用户名显示、改进的 AquaBox 用户牌美观性、导航栏的 i18n 支持、公告功能以及用户个人资料上的自动游戏选择。它还删除了位置设置。

_由于更改看起来很简单,不需要可视化表示,因此未生成任何图表。_

### 文件级别更改

| 变更 | 详情 | 文件 |
| ------ | ------- | ----- |
| 在设置中引入了用户简介的文本区域,并在个人资料页面上显示它。 | <ul><li>将输入字段替换为设置中用于简介的文本区域。</li><li>在用户个人资料页面中添加了个人简介部分以显示简介。</li></ul> | `AquaNet/src/pages/UserHome.svelte`<br/>`AquaNet/src/pages/User/Settings.svelte`<br/>`AquaNet/src/app.sass` |
| 增强了个人资料页面上的用户名显示。 | <ul><li>如果可用,现在显示的是显示名称而不是用户名。</li><li>用户名显示在显示名称下方,字体较小。</li></ul> | `AquaNet/src/pages/UserHome.svelte` |
| 改进了 AquaBox 用户牌,更新了字体、纹理和评分颜色。 | <ul><li>将字体更新为“Gothic A1”。</li><li>添加了新的 DDS 纹理。</li><li>实现了与游戏匹配的评分颜色。</li></ul> | `AquaNet/src/components/settings/userbox/ChuniUserplate.svelte`<br/>`AquaNet/src/libs/userbox/dds.ts`<br/>`AquaNet/src/libs/userbox/userbox.ts` |
| 将导航栏字符串移动到 i18n 以实现更好的本地化。 | <ul><li>导航栏的字符串现在位于 i18n 文件中。</li><li>导航栏现在使用翻译后的字符串。</li></ul> | `AquaNet/src/App.svelte`<br/>`AquaNet/src/libs/i18n/en_ref.ts` |
| 在顶部导航栏中添加了公告功能。 | <ul><li>可以在配置文件中设置公告。</li><li>公告显示在页面顶部。</li><li>为导航栏中的个人资料添加了工具提示,以提高清晰度</li></ul> | `AquaNet/src/App.svelte`<br/>`AquaNet/src/libs/config.ts` |
| 打开用户个人资料时自动选择最近玩过的游戏。 | <ul><li>打开用户个人资料时,代码现在会自动选择最近玩过的游戏。</li><li>如果用户没有玩过任何游戏,代码将重定向到用户的个人资料页面。</li></ul> | `AquaNet/src/pages/UserHome.svelte` |
| 从设置页面中删除了位置设置。 | <ul><li>从设置页面中删除了位置和国家/地区设置。</li></ul> | `AquaNet/src/pages/User/Settings.svelte` |

---

<details>
<summary>提示和命令</summary>

#### 与 Sourcery 互动

- **触发新的审查:** 在 Pull Request 上评论 `@sourcery-ai review`。
- **继续讨论:** 直接回复 Sourcery 的审查评论。
- **从审查评论生成 GitHub issue:** 通过回复审查评论,要求 Sourcery 从审查评论创建一个 issue。您也可以回复审查评论并使用 `@sourcery-ai issue` 从中创建一个 issue。
- **生成 Pull Request 标题:** 在 Pull Request 标题中的任意位置写入 `@sourcery-ai` 以随时生成标题。您也可以在 Pull Request 上评论 `@sourcery-ai title` 以随时(重新)生成标题。
- **生成 Pull Request 摘要:** 在 Pull Request 正文中的任意位置写入 `@sourcery-ai summary` 以随时在您想要的位置生成 PR 摘要。您也可以在 Pull Request 上评论 `@sourcery-ai summary` 以随时(重新)生成摘要。
- **生成审查者指南:** 在 Pull Request 上评论 `@sourcery-ai guide` 以随时(重新)生成审查者指南。
- **解决所有 Sourcery 评论:** 在 Pull Request 上评论 `@sourcery-ai resolve` 以解决所有 Sourcery 评论。如果您已经解决了所有评论并且不想再看到它们,这将非常有用。
- **驳回所有 Sourcery 审查:** 在 Pull Request 上评论 `@sourcery-ai dismiss` 以驳回所有现有的 Sourcery 审查。如果您想重新开始新的审查,这将特别有用 - 不要忘记评论 `@sourcery-ai review` 以触发新的审查!
- **为 issue 生成行动计划:** 在 issue 上评论 `@sourcery-ai plan` 以为其生成行动计划。

#### 自定义您的体验

访问您的 [仪表板](https://app.sourcery.ai) 以:
- 启用或禁用审查功能,例如 Sourcery 生成的 Pull Request 摘要、审查者指南等。
- 更改审查语言。
- 添加、删除或编辑自定义审查说明。
- 调整其他审查设置。

#### 获得帮助

- [联系我们的支持团队](mailto:[email protected]) 提出问题或反馈。
- 访问我们的[文档](https://docs.sourcery.ai) 以获取详细的指南和信息。
- 通过在 [X/Twitter](https://x.com/SourceryAI)、[LinkedIn](https://www.linkedin.com/company/sourcery-ai/) 或 [GitHub](https://github.com/sourcery-ai) 上关注我们,与 Sourcery 团队保持联系。

</details>
Original review guide in English

Reviewer's Guide by Sourcery

This pull request introduces several quality-of-life improvements to AquaNet, including a textarea for the user bio, enhanced username display, improved AquaBox userplate aesthetics, i18n support for the navigation bar, an announcement feature, and automatic game selection on user profiles. It also removes the location settings.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Introduced a textarea for the user bio in settings and display it on the profile page.
  • Replaced the input field with a textarea for the bio in the settings.
  • Added a profile bio section to the user profile page to display the bio.
AquaNet/src/pages/UserHome.svelte
AquaNet/src/pages/User/Settings.svelte
AquaNet/src/app.sass
Enhanced username display on the profile page.
  • If available, the display name is now shown instead of the username.
  • The username is displayed below the display name in a smaller font.
AquaNet/src/pages/UserHome.svelte
Improved the AquaBox userplate with updated fonts, textures, and rating colors.
  • Updated the font to 'Gothic A1'.
  • Added new DDS textures.
  • Implemented rating colors to match the game.
AquaNet/src/components/settings/userbox/ChuniUserplate.svelte
AquaNet/src/libs/userbox/dds.ts
AquaNet/src/libs/userbox/userbox.ts
Moved navigation bar strings to i18n for better localization.
  • The strings for the navigation bar are now located in the i18n files.
  • The navigation bar now uses the translated strings.
AquaNet/src/App.svelte
AquaNet/src/libs/i18n/en_ref.ts
Added an announcement feature to the top navigation bar.
  • An announcement can be set in the config file.
  • The announcement is displayed at the top of the page.
  • Added tooltip to navigation bar for profile for clarity
AquaNet/src/App.svelte
AquaNet/src/libs/config.ts
Automatically select the latest played game when opening a user profile.
  • When opening a user profile, the code now automatically selects the latest played game.
  • If the user has not played any games, the code redirects to the user's profile page.
AquaNet/src/pages/UserHome.svelte
Removed location settings from the settings page.
  • Removed the location and country settings from the settings page.
AquaNet/src/pages/User/Settings.svelte

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@raymonable - 我已经查看了你的更改 - 这里有一些反馈:

总体评论

  • UserHome.svelte 中的自动游戏选择逻辑可以改进,以处理用户没有最近游戏记录的情况。
  • 考虑为 RatingComposition.svelte 中的 comp 属性使用比 any 更具体的类型。
以下是我在审查期间查看的内容
  • 🟢 一般问题:一切看起来都很好
  • 🟢 安全性:一切看起来都很好
  • 🟢 测试:一切看起来都很好
  • 🟡 复杂性:发现 1 个问题
  • 🟢 文档:一切看起来都很好

Sourcery 对开源项目是免费的 - 如果你喜欢我们的评论,请考虑分享它们 ✨
帮助我更有用!请点击每个评论上的 👍 或 👎,我将使用反馈来改进你的评论。
Original comment in English

Hey @raymonable - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The automatic game selection logic in UserHome.svelte could be improved to handle cases where a user has no recent playlogs.
  • Consider using a more specific type than any for the comp prop in RatingComposition.svelte.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@clansty
Copy link
Collaborator

clansty commented Feb 27, 2025

Oh we will have bio!
I want bio too

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants