Skip to content

Conversation

dzienisz
Copy link
Contributor

@dzienisz dzienisz commented Oct 15, 2025

Summary by CodeRabbit

  • Documentation

    • Updated in-app glossary links to point to the “Managing glossaries” docs, including the CSV import format guide.
  • Bug Fixes

    • Corrected outdated documentation URLs shown in empty-glossary and add-first-glossary messages.
  • Chores

    • Temporarily muted the “Import terms” card in empty glossary views and added TODO notes until docs are finalized.

@dzienisz dzienisz requested a review from JanCizmar October 15, 2025 13:30
@dzienisz dzienisz self-assigned this Oct 15, 2025
Copy link
Contributor

coderabbitai bot commented Oct 15, 2025

Walkthrough

Updated documentation links in two EE glossary UI components to point to the managing_glossaries docs; added TODO comments and temporarily commented out the import-terms card and related styling. No public APIs or exported declarations were changed.

Changes

Cohort / File(s) Summary of edits
Docs link updates
webapp/src/ee/glossary/components/AddFirstGlossaryMessage.tsx, webapp/src/ee/glossary/components/GlossaryEmptyListMessage.tsx
Replaced glossary doc links with managing_glossaries; updated CSV import docs link from glossary/import/csv-format to managing_glossaries/import/csv-format.
Disabled import UI block
webapp/src/ee/glossary/components/GlossaryEmptyListMessage.tsx
Commented out the second StyledCard (import-terms UI) and removed the visible import link/button; added a TODO noting temporary disablement until docs are ready.
Styling comment
webapp/src/ee/glossary/components/GlossaryEmptyListMessage.tsx
Commented-out the StyledUploadCloud02 styling declaration and left a commented replacement / note.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I nibble links and tidy traces,
I hop to docs in newer places.
The import card naps, a quiet nook,
Till docs return — I'll take a look.
Tiny paws, a happy tweak, hooray! 🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The PR title states two main objectives: updating glossary documentation links and temporarily hiding the import section. The raw summary confirms that documentation links in both files have been updated from the glossary path to the managing_glossaries path. Additionally, TODO comments were added to indicate enabling features when documentation is ready, which aligns with the "temporarily hide" aspect of the title—these comments suggest conditional display of features pending documentation completion. The title accurately reflects the core changes in the changeset without being overly vague or misleading.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/glossaries-link

📜 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 3ca3ff5 and 101d62a.

📒 Files selected for processing (2)
  • webapp/src/ee/glossary/components/AddFirstGlossaryMessage.tsx (1 hunks)
  • webapp/src/ee/glossary/components/GlossaryEmptyListMessage.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • webapp/src/ee/glossary/components/GlossaryEmptyListMessage.tsx
🧰 Additional context used
🧬 Code graph analysis (1)
webapp/src/ee/glossary/components/AddFirstGlossaryMessage.tsx (1)
webapp/src/constants/links.tsx (1)
  • Link (1-45)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (20)
  • GitHub Check: E2E testing ‍🔎 (15, 14)
  • GitHub Check: E2E testing ‍🔎 (15, 13)
  • GitHub Check: E2E testing ‍🔎 (15, 8)
  • GitHub Check: E2E testing ‍🔎 (15, 9)
  • GitHub Check: E2E testing ‍🔎 (15, 12)
  • GitHub Check: E2E testing ‍🔎 (15, 5)
  • GitHub Check: E2E testing ‍🔎 (15, 2)
  • GitHub Check: E2E testing ‍🔎 (15, 11)
  • GitHub Check: E2E testing ‍🔎 (15, 0)
  • GitHub Check: E2E testing ‍🔎 (15, 10)
  • GitHub Check: E2E testing ‍🔎 (15, 1)
  • GitHub Check: E2E testing ‍🔎 (15, 4)
  • GitHub Check: E2E testing ‍🔎 (15, 6)
  • GitHub Check: E2E testing ‍🔎 (15, 7)
  • GitHub Check: E2E testing ‍🔎 (15, 3)
  • GitHub Check: BT ‍🔎 (ee-test:test)
  • GitHub Check: BT ‍🔎 (server-app:runWebsocketTests)
  • GitHub Check: BT ‍🔎 (server-app:runContextRecreatingTests)
  • GitHub Check: BT ‍🔎 (server-app:runStandardTests)
  • GitHub Check: BT ‍🔎 (server-app:runWithoutEeTests)
🔇 Additional comments (1)
webapp/src/ee/glossary/components/AddFirstGlossaryMessage.tsx (1)

54-54: URL change verified as complete and consistent.

The new documentation URL (https://docs.tolgee.io/platform/projects_and_organizations/managing_glossaries) is accessible and contains relevant glossary management information. All references to the old glossary documentation URL have been removed, and the new URL is used consistently across related files (AddFirstGlossaryMessage.tsx:54, GlossaryEmptyListMessage.tsx:82, and GlossaryEmptyListMessage.tsx:109).


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

Comment @coderabbitai help to get the list of available commands and usage tips.

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

🧹 Nitpick comments (1)
webapp/src/ee/glossary/components/GlossaryEmptyListMessage.tsx (1)

90-113: Consider adding a ticket reference to the TODO and verify the commented code approach.

The import terms functionality has been temporarily disabled by commenting out the entire UI block. While this aligns with the PR's objective, consider the following:

  1. TODO specificity: Add a ticket reference or GitHub issue number to track when this feature should be re-enabled (e.g., TODO(#1234): enable when docs are ready).
  2. Unused prop: The onImport prop is still accepted by the component but is now unused. This is likely intentional for when the feature is re-enabled, but verify this is the desired approach.
  3. Alternative approach: For longer-term temporary disabling, consider using a feature flag instead of commented code to make the toggle more maintainable.

Since this is a temporary measure as indicated by the TODO, the current approach is acceptable for short-term use. However, if the timeline extends beyond a few weeks, consider refactoring to use a feature flag.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d46d827 and a0c23df.

📒 Files selected for processing (2)
  • webapp/src/ee/glossary/components/AddFirstGlossaryMessage.tsx (1 hunks)
  • webapp/src/ee/glossary/components/GlossaryEmptyListMessage.tsx (2 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
webapp/src/ee/glossary/components/AddFirstGlossaryMessage.tsx (1)
webapp/src/constants/links.tsx (1)
  • Link (1-45)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)
  • GitHub Check: BT ‍🔎 (server-app:runWithoutEeTests)
  • GitHub Check: BT ‍🔎 (security:test)
  • GitHub Check: BT ‍🔎 (ktlint:test)
  • GitHub Check: BT ‍🔎 (server-app:runStandardTests)
  • GitHub Check: BT ‍🔎 (data:test)
  • GitHub Check: BT ‍🔎 (server-app:runWebsocketTests)
  • GitHub Check: BT ‍🔎 (ee-test:test)
  • GitHub Check: BT ‍🔎 (server-app:runContextRecreatingTests)
  • GitHub Check: Build frontend 🏗️
🔇 Additional comments (2)
webapp/src/ee/glossary/components/AddFirstGlossaryMessage.tsx (1)

54-54: LGTM! Documentation link updated correctly.

The link now points to the managing_glossaries documentation page, aligning with the PR's objective to update glossary documentation references.

webapp/src/ee/glossary/components/GlossaryEmptyListMessage.tsx (1)

82-82: LGTM! Documentation link updated correctly.

The link now points to the managing_glossaries documentation page, consistent with the changes in AddFirstGlossaryMessage.tsx.

@dzienisz dzienisz force-pushed the fix/glossaries-link branch 2 times, most recently from 3ca3ff5 to 3d95b53 Compare October 15, 2025 22:15
@dzienisz dzienisz force-pushed the fix/glossaries-link branch from 3d95b53 to 101d62a Compare October 15, 2025 22:16
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.

1 participant