[ENG-524] Restructure the UI for Node Types setting

[trangdoan982]

https://www.loom.com/share/56e57e009bf147b0ad039d8283880130

Summary by CodeRabbit

• Refactor

  • Node type settings interface redesigned to use a two-pane layout with separate edit forms and improved validation feedback.
  • Settings layout updated for better spacing and horizontal scrolling of tab buttons.

• Style

  • Removed section headings from General Settings, Relationship Settings, and Relationship Type Settings for a cleaner appearance.

[linear]

ENG-524 Restructure the UI for Node Types setting

[supabase]

This pull request has been ignored for the connected project zytfjzqyijgagqxrzbmz because there are no changes detected in packages/database/supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.

---

Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

[trangdoan982]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes refactor the NodeTypeSettings component from inline editing to a two-pane interface with a dedicated edit form and enhanced validation. Several static heading elements are removed from various settings components. The Settings component's layout is updated for improved spacing and horizontal scrolling of tab buttons. No changes affect component exports.

Changes

File(s)	Change Summary
apps/obsidian/src/components/GeneralSettings.tsx	Removed the static <h3>General Settings</h3> heading from the rendered output.
apps/obsidian/src/components/RelationshipSettings.tsx	Removed the static "Node Type Relations" heading section from the rendered output.
apps/obsidian/src/components/RelationshipTypeSettings.tsx	Removed the static <h3 className="dg-h3">Relation Types</h3> heading from the rendered output.
apps/obsidian/src/components/Settings.tsx	Updated layout: added vertical gap, changed tab button container to flex with horizontal scrolling.
apps/obsidian/src/components/NodeTypeSettings.tsx	Refactored from inline editing to two-pane interface with explicit edit form, centralized validation, and new helpers.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NodeTypeSettings
    participant SettingsStore

    User->>NodeTypeSettings: Selects a node type to edit
    NodeTypeSettings->>NodeTypeSettings: Loads node type into edit form
    User->>NodeTypeSettings: Edits fields (name, template, etc.)
    NodeTypeSettings->>NodeTypeSettings: Validates input fields
    User->>NodeTypeSettings: Clicks Save
    NodeTypeSettings->>NodeTypeSettings: Validates all fields
    alt Validation passes
        NodeTypeSettings->>SettingsStore: Updates node type settings
        NodeTypeSettings->>NodeTypeSettings: Clears editing state
    else Validation fails
        NodeTypeSettings->>User: Displays error messages
    end

Loading

Possibly related PRs

• DiscourseGraphs/discourse-graph#99: Introduces the initial version of NodeTypeSettings with inline editing and basic validation, which is directly refactored in this PR.
• DiscourseGraphs/discourse-graph#94: Adds the original NodeTypeSettings component with add/edit/delete functionality, which is further reworked in this PR.
• DiscourseGraphs/discourse-graph#179: Adds template support to node types, modifying the same component and related UI logic as in this PR.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 39d9ab6 and 315c13e.

📒 Files selected for processing (5)

• apps/obsidian/src/components/GeneralSettings.tsx (0 hunks)
• apps/obsidian/src/components/NodeTypeSettings.tsx (4 hunks)
• apps/obsidian/src/components/RelationshipSettings.tsx (0 hunks)
• apps/obsidian/src/components/RelationshipTypeSettings.tsx (0 hunks)
• apps/obsidian/src/components/Settings.tsx (1 hunks)

💤 Files with no reviewable changes (3)

• apps/obsidian/src/components/RelationshipSettings.tsx
• apps/obsidian/src/components/GeneralSettings.tsx
• apps/obsidian/src/components/RelationshipTypeSettings.tsx

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: CR
PR: DiscourseGraphs/discourse-graph#0
File: .cursor/rules/main.mdc:0-0
Timestamp: 2025-06-30T18:58:32.668Z
Learning: Applies to {apps/website,packages/ui}/**/*.tsx : When refactoring inline styles, use tailwind classes

apps/obsidian/src/components/Settings.tsx (4)

Learnt from: CR
PR: DiscourseGraphs/discourse-graph#0
File: .cursor/rules/main.mdc:0-0
Timestamp: 2025-06-30T18:58:32.668Z
Learning: Applies to {apps/website,packages/ui}/**/*.tsx : Maintain visual consistency with the host application's design system

Learnt from: CR
PR: DiscourseGraphs/discourse-graph#0
File: .cursor/rules/main.mdc:0-0
Timestamp: 2025-06-30T18:58:32.668Z
Learning: Applies to {apps/website,packages/ui}/**/*.tsx : Follow responsive design principles

Learnt from: CR
PR: DiscourseGraphs/discourse-graph#0
File: .cursor/rules/main.mdc:0-0
Timestamp: 2025-06-30T18:58:32.668Z
Learning: Applies to {apps/website,packages/ui}/**/*.tsx : When refactoring inline styles, use tailwind classes

Learnt from: CR
PR: DiscourseGraphs/discourse-graph#0
File: .cursor/rules/main.mdc:0-0
Timestamp: 2025-06-30T18:58:32.668Z
Learning: Applies to **/*.{ts,tsx} : Maintain consistent naming conventions: PascalCase for components and types

apps/obsidian/src/components/NodeTypeSettings.tsx (4)

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#220
File: apps/roam/src/utils/conceptConversion.ts:42-56
Timestamp: 2025-06-17T23:37:45.289Z
Learning: In the DiscourseNode interface from apps/roam/src/utils/getDiscourseNodes.ts, the field `node.type` serves as the UID field rather than having a conventional `node.uid` field. This is an unusual naming convention where the type field actually contains the unique identifier.

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#220
File: apps/roam/src/utils/conceptConversion.ts:42-56
Timestamp: 2025-06-17T23:37:45.289Z
Learning: In the DiscourseNode interface from apps/roam/src/utils/getDiscourseNodes.ts, the field `type` serves as the unique identifier field, not a type classification field. The interface has no `uid` or `id` field, making `node.type` the correct field to use for UID-related operations.

Learnt from: CR
PR: DiscourseGraphs/discourse-graph#0
File: .cursor/rules/main.mdc:0-0
Timestamp: 2025-06-30T18:58:32.668Z
Learning: Applies to **/*.{ts,tsx} : Maintain consistent naming conventions: PascalCase for components and types

Learnt from: sid597
PR: DiscourseGraphs/discourse-graph#226
File: apps/roam/src/components/settings/HomePersonalSettings.tsx:123-149
Timestamp: 2025-06-19T19:43:43.380Z
Learning: The "Fetch Embeddings for nodes" button in HomePersonalSettings.tsx is for testing purposes only, so it doesn't require production-level error handling or user feedback improvements.

🔇 Additional comments (16)

apps/obsidian/src/components/NodeTypeSettings.tsx (14)

2-4: Appropriate imports for the refactored implementation.

The validation utilities and Obsidian UI components are correctly imported to support the new two-pane interface with enhanced validation.

---

10-58: Well-structured field configuration system.

The centralized field configuration with validation functions provides excellent maintainability and type safety. The separation of editable fields and their metadata is a good architectural decision.

---

59-130: Clean component structure with proper separation of concerns.

The field components are well-designed and follow React best practices. The use of a wrapper component ensures consistent layout across all fields.

---

134-162: Improved state management for the two-pane interface.

The granular state management with separate tracking for editing state, validation errors, and selection provides better control over the UI flow.

---

163-199: Robust field-level validation implementation.

The validation logic properly handles required fields and custom validators while maintaining granular error state. The use of destructuring to clear errors is a nice touch.

---

305-334: Comprehensive node type validation.

The validateNodeType function properly iterates through all field configurations and accumulates errors, providing a complete validation pass before save operations.

---

201-212: Efficient field update with immediate validation.

The handleNodeTypeChange function properly updates the field value and triggers validation in one operation, providing immediate feedback to users.

---

226-235: Clean editing state initialization.

The startEditing function properly creates a copy of the node type and resets all relevant state, preventing unintended mutations.

---

246-270: Safe deletion with relation usage check.

The delete operation properly checks if the node type is used in any relations before allowing deletion, preventing data integrity issues.

---

271-296: Proper save flow with validation and state cleanup.

The save operation validates the entire node type before persisting and properly cleans up the editing state after success.

---

336-364: Dynamic field rendering with proper type handling.

The renderField function elegantly handles different field types and properly passes error state and change handlers to child components.

---

366-403: Well-structured list view with proper event handling.

The node list rendering includes proper click handlers, event propagation control, and accessibility labels. The use of Obsidian's setIcon ensures visual consistency.

---

405-441: Comprehensive edit form with validation-aware save button.

The edit form properly disables the save button when there are validation errors or required fields are empty, preventing invalid data submission.

---

443-446: Clean implementation of the two-pane interface pattern.

The conditional rendering based on selectedNodeIndex provides a clear separation between list and edit modes.

apps/obsidian/src/components/Settings.tsx (2)

16-16: Good use of Tailwind utilities for consistent spacing.

Adding gap-4 provides uniform vertical spacing between the title, tabs, and content sections, improving visual hierarchy.

---

19-19: Excellent responsive design improvement.

Adding flex w-full overflow-x-auto ensures tabs remain accessible on smaller screens by enabling horizontal scrolling when needed, following responsive design best practices.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this PR.
• @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.

[mdroidian]

Looks good! Just a few small changes before merging.