Skip to content

feature - left nav match #217

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

Merged
merged 6 commits into from
Jan 16, 2025
Merged

feature - left nav match #217

merged 6 commits into from
Jan 16, 2025

Conversation

ken-zlai
Copy link
Contributor

@ken-zlai ken-zlai commented Jan 15, 2025

Summary

This PR updates the left navigation to align with the new structure in the Figma design. The updated order places Home at the top, followed by your dataset entities, and then resources at the bottom.

In a future PR, I will add templates for the Models, Groupbys, and Staging Queries pages, including tabs for Observability and Job Tracking. Currently, these routes will result in a 404 error.

Checklist

  • Added Unit Tests
  • Covered by existing CI
  • Integration tested
  • Documentation update

Copy link

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request introduces significant updates to the frontend navigation structure. The changes modify the NavigationBar.svelte component, update the Entity.ts configuration, and adjust the +layout.svelte route to display a more comprehensive set of navigation items. The modifications enhance the navigation experience by adding new sections, separators, and expanding the range of accessible entities.

Changes

File Change Summary
frontend/src/lib/components/NavigationBar/NavigationBar.svelte - Added IconSquaresSolid icon
- Introduced Separator components
- Modified navigation layout
- Added "Home", "Datasets", and "Resources" sections
frontend/src/lib/types/Entity/Entity.ts - Removed IconPuzzlePiece icon
- Added IconCubeTransparent and IconRectangleStack icons
- Updated GroupBys entry
- Added new "Staging Queries" entry
frontend/src/routes/+layout.svelte - Changed navItems prop to pass entire entityConfig array

Sequence Diagram

sequenceDiagram
    participant User
    participant NavigationBar
    participant EntityConfig
    
    User->>NavigationBar: Interact with navigation
    NavigationBar->>EntityConfig: Retrieve all entities
    EntityConfig-->>NavigationBar: Return full entity list
    NavigationBar->>User: Display comprehensive navigation
Loading

Possibly related PRs

Suggested reviewers

  • sean-zlai
  • nikhil-zlai

Poem

🧭 Navigating paths anew,
Buttons dance, icons breakthrough
Separators mark the way
To datasets bright as day
A digital journey's gentle sway! 🚀

Warning

Review ran into problems

🔥 Problems

GitHub Actions: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository.

Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings.

Finishing Touches

  • 📝 Generate Docstrings (Beta)

🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

@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: 1

🧹 Nitpick comments (1)
frontend/src/lib/components/NavigationBar/NavigationBar.svelte (1)

162-162: Use appropriate icon for Support button.

IconDocumentText is reused from docs button. Consider using a support-specific icon.

-		<IconDocumentText class="text-muted-icon-neutral" />
+		<IconQuestionMarkCircle class="text-muted-icon-neutral" />
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between e43a330 and 6a690f6.

📒 Files selected for processing (3)
  • frontend/src/lib/components/NavigationBar/NavigationBar.svelte (3 hunks)
  • frontend/src/lib/types/Entity/Entity.ts (2 hunks)
  • frontend/src/routes/+layout.svelte (1 hunks)
🔇 Additional comments (2)
frontend/src/routes/+layout.svelte (1)

26-26: LGTM!

Passing full entityConfig enables complete navigation structure.

frontend/src/lib/components/NavigationBar/NavigationBar.svelte (1)

Line range hint 118-165: LGTM!

Navigation structure matches design requirements with clear sections and separators.

Comment on lines +21 to +22
path: '/GroupBys',
icon: IconRectangleStack,
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Fix path casing inconsistency.

Paths should use lowercase for consistency with other routes.

-		path: '/GroupBys',
+		path: '/groupbys',
-		path: '/StagingQueries',
+		path: '/staging-queries',

Also applies to: 28-29

@ken-zlai ken-zlai requested a review from sean-zlai January 15, 2025 20:44
Copy link
Contributor

@sean-zlai sean-zlai left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @ken-zlai

@ken-zlai ken-zlai merged commit 1ffd5c4 into main Jan 16, 2025
4 checks passed
@ken-zlai ken-zlai deleted the ken/new-nav-match branch January 16, 2025 14:00
david-zlai pushed a commit that referenced this pull request Jan 17, 2025
## Summary

This PR updates the left navigation to align with the new structure in
the Figma design. The updated order places **Home** at the top, followed
by **your dataset entities**, and then **resources** at the bottom.

In a future PR, I will add templates for the **Models**, **Groupbys**,
and **Staging Queries** pages, including tabs for **Observability** and
**Job Tracking**. Currently, these routes will result in a 404 error.

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
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.

2 participants