[PR #145] [MERGED] Markdown documentation for HTTP requests #79

Closed
opened 2025-12-29 07:19:14 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/mountain-loop/yaak/pull/145
Author: @gschier
Created: 12/17/2024
Status: Merged
Merged: 12/19/2024
Merged by: @gschier

Base: masterHead: markdown-docs


📝 Commits (7)

📊 Changes

30 files changed (+2306 additions, -283 deletions)

View changed files

📝 package-lock.json (+1580 -44)
src-tauri/migrations/20241217204951_docs.sql (+8 -0)
📝 src-tauri/src/lib.rs (+3 -3)
📝 src-tauri/yaak_models/bindings/models.ts (+3 -3)
📝 src-tauri/yaak_models/src/models.rs (+9 -0)
📝 src-tauri/yaak_models/src/queries.rs (+18 -9)
src-web/components/FolderSettingsDialog.tsx (+46 -0)
📝 src-web/components/GrpcConnectionSetupPane.tsx (+51 -14)
src-web/components/MarkdownEditor.tsx (+137 -0)
src-web/components/Prose.css (+201 -0)
src-web/components/Prose.tsx (+12 -0)
📝 src-web/components/RequestPane.tsx (+82 -74)
📝 src-web/components/ResponsePane.tsx (+7 -8)
📝 src-web/components/Sidebar.tsx (+21 -34)
📝 src-web/components/UrlBar.tsx (+19 -15)
src-web/components/WorkpaceSettingsDialog.tsx (+39 -0)
📝 src-web/components/Workspace.tsx (+1 -10)
📝 src-web/components/WorkspaceActionsDropdown.tsx (+11 -24)
📝 src-web/components/WorkspaceHeader.tsx (+1 -0)
📝 src-web/components/core/CountBadge.tsx (+3 -2)

...and 10 more files

📄 Description

Add support to add Markdown documentation to HTTP requests, GRPC requests, folders, and workspaces.

  • Add description field to appropriate models
  • Add new <MarkdownEditor/> component using react-markdown (with GFM plugin)
  • Create Settings dialogs for Workspace and Folder, to change name and description

CleanShot 2024-12-19 at 05 49 58@2x

CleanShot 2024-12-19 at 05 51 23@2x

CleanShot 2024-12-19 at 05 54 00@2x


🔄 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/mountain-loop/yaak/pull/145 **Author:** [@gschier](https://github.com/gschier) **Created:** 12/17/2024 **Status:** ✅ Merged **Merged:** 12/19/2024 **Merged by:** [@gschier](https://github.com/gschier) **Base:** `master` ← **Head:** `markdown-docs` --- ### 📝 Commits (7) - [`54dd0d0`](https://github.com/mountain-loop/yaak/commit/54dd0d04a2641d7aee340249a9876fa585aa7654) Markdown documentation for HTTP requests - [`6340baa`](https://github.com/mountain-loop/yaak/commit/6340baa63408ac02e09a499e7854bcf25654d678) Add Workspace and Folder description editors - [`8630371`](https://github.com/mountain-loop/yaak/commit/8630371ea6c6f0b7306fb24c450584738eaf7912) Tweak tabs - [`ddf1062`](https://github.com/mountain-loop/yaak/commit/ddf106253fa1ab152605a4e11fa2b955807b7cd5) Final tweaks - [`90e8c13`](https://github.com/mountain-loop/yaak/commit/90e8c13c207e7a85405b7b7e7393c720c6a9b307) Some more tweaks - [`5825d5e`](https://github.com/mountain-loop/yaak/commit/5825d5e4febd58f5f51ccb75f9962a42b5d6a6bd) Update count badge style - [`2b57811`](https://github.com/mountain-loop/yaak/commit/2b578110aba734d2702d7e741004e599500dd71e) Update editor rounded ### 📊 Changes **30 files changed** (+2306 additions, -283 deletions) <details> <summary>View changed files</summary> 📝 `package-lock.json` (+1580 -44) ➕ `src-tauri/migrations/20241217204951_docs.sql` (+8 -0) 📝 `src-tauri/src/lib.rs` (+3 -3) 📝 `src-tauri/yaak_models/bindings/models.ts` (+3 -3) 📝 `src-tauri/yaak_models/src/models.rs` (+9 -0) 📝 `src-tauri/yaak_models/src/queries.rs` (+18 -9) ➕ `src-web/components/FolderSettingsDialog.tsx` (+46 -0) 📝 `src-web/components/GrpcConnectionSetupPane.tsx` (+51 -14) ➕ `src-web/components/MarkdownEditor.tsx` (+137 -0) ➕ `src-web/components/Prose.css` (+201 -0) ➕ `src-web/components/Prose.tsx` (+12 -0) 📝 `src-web/components/RequestPane.tsx` (+82 -74) 📝 `src-web/components/ResponsePane.tsx` (+7 -8) 📝 `src-web/components/Sidebar.tsx` (+21 -34) 📝 `src-web/components/UrlBar.tsx` (+19 -15) ➕ `src-web/components/WorkpaceSettingsDialog.tsx` (+39 -0) 📝 `src-web/components/Workspace.tsx` (+1 -10) 📝 `src-web/components/WorkspaceActionsDropdown.tsx` (+11 -24) 📝 `src-web/components/WorkspaceHeader.tsx` (+1 -0) 📝 `src-web/components/core/CountBadge.tsx` (+3 -2) _...and 10 more files_ </details> ### 📄 Description Add support to add Markdown documentation to HTTP requests, GRPC requests, folders, and workspaces. - Add `description` field to appropriate models - Add new `<MarkdownEditor/>` component using `react-markdown` (with GFM plugin) - Create Settings dialogs for Workspace and Folder, to change name and description ![CleanShot 2024-12-19 at 05 49 58@2x](https://github.com/user-attachments/assets/e3113b71-941e-4fd6-99d3-3af898d680cd) ![CleanShot 2024-12-19 at 05 51 23@2x](https://github.com/user-attachments/assets/e03768ba-2664-4b17-8f93-e68453beeb21) ![CleanShot 2024-12-19 at 05 54 00@2x](https://github.com/user-attachments/assets/4169d3bf-4e2e-4e8c-9865-d1e170640925) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 07:19:14 +01:00
adam closed this issue 2025-12-29 07:19:14 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/yaak#79