[PR #5620] [MERGED] feat: improve documentation UI and add published docs indicators #5288

New issue

Closed

opened 2026-03-17 02:45:00 +03:00 by kerem · 0 comments

kerem commented

2026-03-17 02:45:00 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hoppscotch/hoppscotch/pull/5620
Author: @nivedin
Created: 11/26/2025
Status: ✅ Merged
Merged: 11/27/2025
Merged by: @jamesgeorge007

Base: next ← Head: chore/improve-doc-ui

📝 Commits (10+)

4511b22 chore: reorder menu items
b66e60f chore: reorder modal buttons
4732e15 chore: update markdown editor color
4fea7ef chore: hide empty doc editor
c443a73 chore: update doc modal button
e20364f chore: update doc header title UI
5e7f2d5 chore: add SEO meta in doc page
556fc62 chore: allow nullable collectionID in published docs queries
cf608f7 chore: show published icon for collection
fc8aaa0 chore: add tests and cleanup

📊 Changes

19 files changed (+613 additions, -195 deletions)

View changed files

📝 packages/hoppscotch-backend/src/auth/auth.module.ts (+4 -0)
📝 packages/hoppscotch-backend/src/published-docs/published-docs.resolver.ts (+2 -1)
📝 packages/hoppscotch-backend/src/published-docs/published-docs.service.spec.ts (+0 -1)
📝 packages/hoppscotch-backend/src/published-docs/published-docs.service.ts (+1 -2)
📝 packages/hoppscotch-backend/src/user-collection/user-collection.resolver.ts (+0 -1)
📝 packages/hoppscotch-common/locales/en.json (+6 -1)
📝 packages/hoppscotch-common/src/components/collections/Collection.vue (+39 -13)
📝 packages/hoppscotch-common/src/components/collections/MyCollections.vue (+1 -6)
📝 packages/hoppscotch-common/src/components/collections/documentation/MarkdownEditor.vue (+14 -5)
📝 packages/hoppscotch-common/src/components/collections/documentation/PublishDocModal.vue (+44 -34)
📝 packages/hoppscotch-common/src/components/collections/documentation/index.vue (+52 -112)
📝 packages/hoppscotch-common/src/components/documentation/Header.vue (+3 -1)
📝 packages/hoppscotch-common/src/helpers/backend/gql/queries/TeamPublishedDocsList.graphql (+1 -1)
📝 packages/hoppscotch-common/src/helpers/backend/queries/PublishedDocs.ts (+1 -1)
📝 packages/hoppscotch-common/src/pages/view/_id/_version.vue (+69 -0)
📝 packages/hoppscotch-common/src/services/__tests__/documentation.service.spec.ts (+194 -1)
📝 packages/hoppscotch-common/src/services/__tests__/workspace.service.spec.ts (+36 -8)
📝 packages/hoppscotch-common/src/services/documentation.service.ts (+131 -1)
📝 packages/hoppscotch-common/src/services/workspace.service.ts (+15 -6)

📄 Description

Closes FE-1072

This PR improves the documentation UI and reorders the collection context menu. Also add's a Globe icon indicator to show active published state.

What's changed

Notes to reviewers

Summary by cubic

Improved the documentation UI, reordered the collection context menu, and added a published-docs indicator so docs are easier to access and manage. Closes FE-1072.

New Features
- Show a globe icon on collections with published docs.
- Cache and surface published doc status via DocumentationService; auto-fetch per workspace/team.
Refactors
- Moved the Documentation action higher in the collection menu.
- Streamlined the Publish modal: added tooltips for Copy URL and Open, moved Cancel to the end, and only show actions when a URL exists.
- Updated the Markdown editor colors and placeholder, and hide the editor when read-only and empty.
- Reordered Save/Close in the documentation view and updated the copy tooltip to “Copy URL”.
- Added SEO metadata to the published docs page (title, OpenGraph, Twitter).
- Made team published docs query accept optional collectionID.
- Added i18n keys: action.open, documentation.publish.delete, documentation.publish.open_published_doc, documentation.publish.unpublish.
- Prevented race conditions when fetching published doc status in DocumentationService.

^{Written for commit 6b0c84dc36. Summary will update automatically on new commits.}

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/hoppscotch/hoppscotch/pull/5620 **Author:** [@nivedin](https://github.com/nivedin) **Created:** 11/26/2025 **Status:** ✅ Merged **Merged:** 11/27/2025 **Merged by:** [@jamesgeorge007](https://github.com/jamesgeorge007) **Base:** `next` ← **Head:** `chore/improve-doc-ui` --- ### 📝 Commits (10+) - [`4511b22`](https://github.com/hoppscotch/hoppscotch/commit/4511b2209a78608287ced48e30a573a3962a77ed) chore: reorder menu items - [`b66e60f`](https://github.com/hoppscotch/hoppscotch/commit/b66e60f744536484793f8758198f6aeff362a99f) chore: reorder modal buttons - [`4732e15`](https://github.com/hoppscotch/hoppscotch/commit/4732e1509b4eb92aa68ff0d7e49c807bde733698) chore: update markdown editor color - [`4fea7ef`](https://github.com/hoppscotch/hoppscotch/commit/4fea7ef7c2aa0286d7aa584b0449bef24778c024) chore: hide empty doc editor - [`c443a73`](https://github.com/hoppscotch/hoppscotch/commit/c443a73a64c57ecff94663230f8e333887897b5d) chore: update doc modal button - [`e20364f`](https://github.com/hoppscotch/hoppscotch/commit/e20364f3bf32b563d718cc89a1d02d14abffd0d0) chore: update doc header title UI - [`5e7f2d5`](https://github.com/hoppscotch/hoppscotch/commit/5e7f2d5a4931ebe249c2755d4de476e7c96cf8a5) chore: add SEO meta in doc page - [`556fc62`](https://github.com/hoppscotch/hoppscotch/commit/556fc622d65a6f79f82fceb6d829fc8dd1844133) chore: allow nullable collectionID in published docs queries - [`cf608f7`](https://github.com/hoppscotch/hoppscotch/commit/cf608f75418765afeed240aaf44011a8e79ac7d4) chore: show published icon for collection - [`fc8aaa0`](https://github.com/hoppscotch/hoppscotch/commit/fc8aaa0751e29bf95289003ec03f09c519c08fef) chore: add tests and cleanup ### 📊 Changes **19 files changed** (+613 additions, -195 deletions) <details> <summary>View changed files</summary> 📝 `packages/hoppscotch-backend/src/auth/auth.module.ts` (+4 -0) 📝 `packages/hoppscotch-backend/src/published-docs/published-docs.resolver.ts` (+2 -1) 📝 `packages/hoppscotch-backend/src/published-docs/published-docs.service.spec.ts` (+0 -1) 📝 `packages/hoppscotch-backend/src/published-docs/published-docs.service.ts` (+1 -2) 📝 `packages/hoppscotch-backend/src/user-collection/user-collection.resolver.ts` (+0 -1) 📝 `packages/hoppscotch-common/locales/en.json` (+6 -1) 📝 `packages/hoppscotch-common/src/components/collections/Collection.vue` (+39 -13) 📝 `packages/hoppscotch-common/src/components/collections/MyCollections.vue` (+1 -6) 📝 `packages/hoppscotch-common/src/components/collections/documentation/MarkdownEditor.vue` (+14 -5) 📝 `packages/hoppscotch-common/src/components/collections/documentation/PublishDocModal.vue` (+44 -34) 📝 `packages/hoppscotch-common/src/components/collections/documentation/index.vue` (+52 -112) 📝 `packages/hoppscotch-common/src/components/documentation/Header.vue` (+3 -1) 📝 `packages/hoppscotch-common/src/helpers/backend/gql/queries/TeamPublishedDocsList.graphql` (+1 -1) 📝 `packages/hoppscotch-common/src/helpers/backend/queries/PublishedDocs.ts` (+1 -1) 📝 `packages/hoppscotch-common/src/pages/view/_id/_version.vue` (+69 -0) 📝 `packages/hoppscotch-common/src/services/__tests__/documentation.service.spec.ts` (+194 -1) 📝 `packages/hoppscotch-common/src/services/__tests__/workspace.service.spec.ts` (+36 -8) 📝 `packages/hoppscotch-common/src/services/documentation.service.ts` (+131 -1) 📝 `packages/hoppscotch-common/src/services/workspace.service.ts` (+15 -6) </details> ### 📄 Description   Closes FE-1072 This PR improves the documentation UI and reorders the collection context menu. Also add's a Globe icon indicator to show active published state.  ### What's changed   ### Notes to reviewers   --- ## Summary by cubic Improved the documentation UI, reordered the collection context menu, and added a published-docs indicator so docs are easier to access and manage. Closes FE-1072. - **New Features** - Show a globe icon on collections with published docs. - Cache and surface published doc status via DocumentationService; auto-fetch per workspace/team. - **Refactors** - Moved the Documentation action higher in the collection menu. - Streamlined the Publish modal: added tooltips for Copy URL and Open, moved Cancel to the end, and only show actions when a URL exists. - Updated the Markdown editor colors and placeholder, and hide the editor when read-only and empty. - Reordered Save/Close in the documentation view and updated the copy tooltip to “Copy URL”. - Added SEO metadata to the published docs page (title, OpenGraph, Twitter). - Made team published docs query accept optional collectionID. - Added i18n keys: action.open, documentation.publish.delete, documentation.publish.open_published_doc, documentation.publish.unpublish. - Prevented race conditions when fetching published doc status in DocumentationService. <sup>Written for commit 6b0c84dc3691a3d4a1c3cb6966f6b6fa2b08a9a0. Summary will update automatically on new commits.</sup>  --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>