[PR #5286] [MERGED] docs(agent): add README #5141

New issue

Closed

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

kerem commented

2026-03-17 02:37:07 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hoppscotch/hoppscotch/pull/5286
Author: @CuriousCorrelation
Created: 7/28/2025
Status: ✅ Merged
Merged: 7/28/2025
Merged by: @jamesgeorge007

Base: next ← Head: docs-agent-update-readme

📝 Commits (1)

9054365 docs(agent): add README

📊 Changes

2 files changed (+274 additions, -9 deletions)

View changed files

📝 packages/hoppscotch-agent/README.md (+274 -9)
➕ packages/hoppscotch-agent/public/icon.png (+0 -0)

📄 Description

This adds documentation for the Hoppscotch Agent package covering
installation, configuration, and usage.

Closes FE-942
Closes #5284

The agent package lacked user-facing documentation beyond the minimal
Tauri template content. Users needed guidance for installation,
registration, certificate management, proxy configuration, and
troubleshooting.

Implementation

The documentation covers the complete agent feature set including
system requirements, platform-specific file locations, etc.

Notes to reviewers

This change only adds documentation and doesn't modify any functional
behavior. The README provides users with the guidance needed to
install, configure, and troubleshoot the agent across supported
platforms.

_{🔄 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/5286 **Author:** [@CuriousCorrelation](https://github.com/CuriousCorrelation) **Created:** 7/28/2025 **Status:** ✅ Merged **Merged:** 7/28/2025 **Merged by:** [@jamesgeorge007](https://github.com/jamesgeorge007) **Base:** `next` ← **Head:** `docs-agent-update-readme` --- ### 📝 Commits (1) - [`9054365`](https://github.com/hoppscotch/hoppscotch/commit/90543655c0c02280f5c07f46b767b8441f27afec) docs(agent): add README ### 📊 Changes **2 files changed** (+274 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `packages/hoppscotch-agent/README.md` (+274 -9) ➕ `packages/hoppscotch-agent/public/icon.png` (+0 -0) </details> ### 📄 Description This adds documentation for the Hoppscotch Agent package covering installation, configuration, and usage. Closes FE-942 Closes #5284 The agent package lacked user-facing documentation beyond the minimal Tauri template content. Users needed guidance for installation, registration, certificate management, proxy configuration, and troubleshooting. ### Implementation The documentation covers the complete agent feature set including system requirements, platform-specific file locations, etc. ### Notes to reviewers This change only adds documentation and doesn't modify any functional behavior. The README provides users with the guidance needed to install, configure, and troubleshoot the agent across supported platforms. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>