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

epic: Standardized Error Format for Jan #2482

Closed
imtuyethan opened this issue Mar 24, 2024 · 1 comment
Closed

epic: Standardized Error Format for Jan #2482

imtuyethan opened this issue Mar 24, 2024 · 1 comment
Assignees
Labels
type: epic A major feature or initiative
Milestone

Comments

@imtuyethan
Copy link
Contributor

imtuyethan commented Mar 24, 2024

Motivation

The current error handling system in Jan app has too many edge cases, which is challenging to maintain. Our goal is to implement a simplified, standardized error format within the Jan app, focusing on improving maintainability, and providing better context for error handling.

Key Results

  • Less hassle: We'll save time by using a standard template instead of creating unique messages for each scenario.
  • Efficient troubleshooting: Standardized messages speed up troubleshooting for both users and app pod.

Specs

https://www.notion.so/jan-ai/Standardized-Error-Format-for-Jan-abea56d32d6648bb8c6835f9176f800c?pvs=4

Key User Stories

  • Users should see a clear & standardized error message
  • Users see inline error message in threads
  • Error message should be saved in threads so users can look back when they need to
  • Errors:
    • For unclear errors, users should see troubleshooting guide & can file Github issue
    • For identified error, we should map it with error code & recommended actions

Designs

https://www.figma.com/file/DYfpMhf8qiSReKvYooBgDV/Jan-App-(version-2)?type=design&node-id=2858-90537&mode=design&t=bjtQNvQF32BiMtU5-4

Image

@imtuyethan imtuyethan added the type: epic A major feature or initiative label Mar 24, 2024
@louis-menlo louis-menlo moved this to Icebox in Menlo Mar 25, 2024
@louis-menlo louis-menlo moved this from Icebox to Planned in Menlo Mar 25, 2024
@louis-menlo louis-menlo removed their assignment Apr 5, 2024
@imtuyethan imtuyethan modified the milestones: v0.4.11, v0.4.12 Apr 15, 2024
@louis-menlo
Copy link
Contributor

Duplicated, #2556

@louis-menlo louis-menlo closed this as not planned Won't fix, can't repro, duplicate, stale Apr 16, 2024
@github-project-automation github-project-automation bot moved this from Planned to Done in Menlo Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: epic A major feature or initiative
Projects
Archived in project
Development

No branches or pull requests

4 participants