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

fix: improve document loading ui consistency #1082

Merged
merged 2 commits into from
Apr 9, 2024
Merged

Conversation

dguyen
Copy link
Collaborator

@dguyen dguyen commented Apr 6, 2024

Description

General UI updates

Changes Made

  • Add consistent spacing between document edit/view/log pages
  • Add document status to document audit log page
  • Update document loading page to reserve space for the document status below the title
  • Update the document audit log page to show full dates in the correct locale

Copy link
Contributor

coderabbitai bot commented Apr 6, 2024

Walkthrough

The recent updates focus on enhancing user interface and localization aspects of the document management system. Adjustments were made to improve visual spacing in the document editing view, introduce a loading UI for a smoother user experience, and refine the logs page with locale-aware date formatting and a more informative display of document statuses and user details. These changes collectively aim to provide a more intuitive and responsive interface for users.

Changes

Files Summary
.../documents/[id]/edit/document-edit-page-view.tsx Adjusted top margin spacing of the EditDocumentForm.
.../documents/[id]/loading.tsx Introduced a Skeleton component for a loading UI effect.
.../documents/[id]/logs/document-logs-page-view.tsx Enhanced logs page with locale-aware date formatting, improved user and document status display.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

vercel bot commented Apr 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
stg-app ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 8, 2024 2:13pm
stg-marketing ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 8, 2024 2:13pm
2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
prd-app ⬜️ Ignored (Inspect) Apr 8, 2024 2:13pm
prd-marketing ⬜️ Ignored (Inspect) Apr 8, 2024 2:13pm

@github-actions github-actions bot added the apps: web Issues related to the webapp label Apr 6, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between fc70f78 and ffa36e1.
Files selected for processing (3)
  • apps/web/src/app/(dashboard)/documents/[id]/edit/document-edit-page-view.tsx (1 hunks)
  • apps/web/src/app/(dashboard)/documents/[id]/loading.tsx (2 hunks)
  • apps/web/src/app/(dashboard)/documents/[id]/logs/document-logs-page-view.tsx (5 hunks)
Additional comments not posted (7)
apps/web/src/app/(dashboard)/documents/[id]/loading.tsx (2)

5-5: The import of Skeleton is correctly implemented.


19-21: The addition of the Skeleton component enhances the loading UI. Ensure its styling and behavior are verified during runtime.

apps/web/src/app/(dashboard)/documents/[id]/edit/document-edit-page-view.tsx (1)

103-103: Adjustment to the top margin spacing of EditDocumentForm is appropriate for UI consistency. Verify the visual consistency across different pages.

apps/web/src/app/(dashboard)/documents/[id]/logs/document-logs-page-view.tsx (4)

5-5: The imports for DateTime and getLocale are correctly implemented for locale-specific date formatting.

Also applies to: 9-9


16-19: Introduction of DocumentStatusComponent for displaying document status enhances information clarity. Verify the display of document status in different scenarios.

Also applies to: 125-131


83-85: Enhancements to date formatting using DateTime with locale are significant for internationalization. Verify the date formatting across different locales.

Also applies to: 89-91


77-79: Modifications to the display format for the user's name, email, and recipient role improve readability and context. Verify the readability and context provided by the new display formats.

Also applies to: 106-106

@ElTimuro
Copy link
Member

ElTimuro commented Apr 8, 2024

@dguyen fyi this exists: https://github.com/documenso/backlog-internal/issues/45
is this out of scope? seemed you touched some update things as well

@dguyen
Copy link
Collaborator Author

dguyen commented Apr 8, 2024

@ElTimuro yeah that's a different scope unrelated to these changes

I've prototyped some solutions for that issue but there doesn't seem to be an easy clean way to solve it

I'll try to write some stuff down for that later explaining potential solutions and why it can't be done easily

@ElTimuro
Copy link
Member

ElTimuro commented Apr 8, 2024

Great, no worries tho. I assumed it's not trivial

@dguyen dguyen merged commit 1400c33 into main Apr 9, 2024
13 checks passed
@dguyen dguyen deleted the fix/document-loading-ui branch April 9, 2024 04:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apps: web Issues related to the webapp
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants