feat:Added collection name and minor UI changes to the generate doc modal#8391
feat:Added collection name and minor UI changes to the generate doc modal#8391sachin-bruno wants to merge 3 commits into
Conversation
Walkthrough
ChangesGenerate Documentation Modal
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/StyledWrapper.js (1)
33-38: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win
.collection-nameneeds truncation rules to back upmin-width: 0.
min-width: 0only enables shrinking — on its own it does nothing visible. A long collection name will wrap or push thenowrapversion off the line. Add ellipsis truncation to finish the job.♻️ Proposed fix
.collection-name { font-weight: 500; font-size: ${(props) => props.theme.font.size.base}; color: ${(props) => props.theme.text}; min-width: 0; + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/StyledWrapper.js` around lines 33 - 38, The .collection-name style in StyledWrapper only sets min-width: 0, which allows shrinking but does not truncate long text. Update the collection-name rule to include the usual ellipsis truncation behavior so long names do not wrap or overflow; keep the fix scoped to the collection-name selector in StyledWrapper.js.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In
`@packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/StyledWrapper.js`:
- Around line 33-38: The .collection-name style in StyledWrapper only sets
min-width: 0, which allows shrinking but does not truncate long text. Update the
collection-name rule to include the usual ellipsis truncation behavior so long
names do not wrap or overflow; keep the fix scoped to the collection-name
selector in StyledWrapper.js.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 110aa513-11ef-4a54-bf1a-8fee93cc212b
📒 Files selected for processing (7)
packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/CollectionVersionInfo/index.jspackages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/CollectionVersionInfo/index.spec.jspackages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/EnvironmentSelectionList/index.jspackages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/StyledWrapper.jspackages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/index.jstests/collection/generate-docs/generate-docs.spec.tstests/utils/page/locators.ts
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/CollectionVersionInfo/index.js`:
- Around line 11-12: The version display in CollectionVersionInfo is adding a
prefixed label instead of showing the raw collection version. Update the render
logic in the version-value span so it outputs the version prop verbatim,
matching the value passed from the modal, and keep the existing conditional
around version in place.
In
`@packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/CollectionVersionInfo/index.spec.js`:
- Around line 7-38: Add a test in CollectionVersionInfo’s spec to cover the new
collection name element rendered by CollectionVersionInfo, since the current
suite only checks version and summary text. Update index.spec.js to assert the
presence and content of the collection-name output for a rendered name prop, and
include a negative/edge case if the component hides it conditionally.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 9fb0ef94-613a-4063-a17a-26f23d0cbabc
📒 Files selected for processing (4)
packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/CollectionVersionInfo/index.jspackages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/CollectionVersionInfo/index.spec.jspackages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/index.jstests/collection/generate-docs/generate-docs.spec.ts
🚧 Files skipped from review as they are similar to previous changes (2)
- packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/index.js
- tests/collection/generate-docs/generate-docs.spec.ts
Description
Problem
Generated documentation includes every environment in the collection, with no way to scope which envs ship, so internal, local, or staging envs leak into docs shared externally. The modal also doesn't surface which collection version the docs represent.
Contribution Checklist:
Note: Keeping the PR small and focused helps make it easier to review and merge. If you have multiple changes you want to make, please consider submitting them as separate pull requests.
Publishing to New Package Managers
Please see here for more information.

Summary by CodeRabbit
New Features
UI Improvements