|
| 1 | +# Hashgraph Online (HOL) Docset |
| 2 | + |
| 3 | +## Author |
| 4 | +- **GitHub**: [hashgraph-online](https://github.com/hashgraph-online) |
| 5 | +- **Twitter/X**: [@HashgraphOnline](https://x.com/HashgraphOnline) |
| 6 | + |
| 7 | +## What is Hashgraph Online? |
| 8 | + |
| 9 | +Hashgraph Online (HOL) is the **Universal Agentic Registry** - a decentralized directory for AI Agents and MCP Servers. It provides blockchain-based identity, discovery, and encrypted communication for autonomous AI agents across Web2 and Web3. |
| 10 | + |
| 11 | +**Key Features:** |
| 12 | +- Agent discovery across 46,000+ indexed agents |
| 13 | +- Multi-protocol support (A2A, MCP, XMTP, ERC-8004) |
| 14 | +- Blockchain-based identity (HCS-14 Universal Agent ID) |
| 15 | +- Encrypted agent-to-agent communication |
| 16 | +- MCP server integration for Claude Desktop, Cursor IDE |
| 17 | + |
| 18 | +## Documentation Source |
| 19 | + |
| 20 | +- **Main Docs**: https://hol.org/docs/registry-broker/ |
| 21 | +- **SDK Docs**: https://hol.org/docs/libraries/standards-sdk/ |
| 22 | +- **Standards**: https://hol.org/docs/standards/hcs-1 |
| 23 | +- **Live Registry**: https://hol.org/registry |
| 24 | + |
| 25 | +## How to Generate the Docset |
| 26 | + |
| 27 | +### Prerequisites |
| 28 | + |
| 29 | +- Node.js 20+ |
| 30 | +- pnpm (or npm) |
| 31 | +- sqlite3 (usually pre-installed on macOS/Linux) |
| 32 | +- ImageMagick (for icon generation) |
| 33 | + |
| 34 | +### Generation Steps |
| 35 | + |
| 36 | +The generation script (`generate-docset.ts`) is included in this folder. |
| 37 | + |
| 38 | +```bash |
| 39 | +# Create a working directory and copy the script |
| 40 | +mkdir hol-docset && cd hol-docset |
| 41 | +cp /path/to/generate-docset.ts . |
| 42 | + |
| 43 | +# Create package.json |
| 44 | +cat > package.json << 'EOF' |
| 45 | +{ |
| 46 | + "name": "hol-docset-generator", |
| 47 | + "version": "1.0.0", |
| 48 | + "type": "module", |
| 49 | + "scripts": { |
| 50 | + "generate": "pnpm exec tsx generate-docset.ts" |
| 51 | + }, |
| 52 | + "devDependencies": { |
| 53 | + "@types/node": "^20.0.0", |
| 54 | + "tsx": "^4.0.0", |
| 55 | + "typescript": "^5.0.0" |
| 56 | + } |
| 57 | +} |
| 58 | +EOF |
| 59 | + |
| 60 | +# Install dependencies |
| 61 | +pnpm install |
| 62 | + |
| 63 | +# Generate docset |
| 64 | +pnpm run generate |
| 65 | + |
| 66 | +# Create icons (requires ImageMagick) |
| 67 | +# Download icon from https://hol.org or use the one from hcs-improvement-proposals repo |
| 68 | +magick /path/to/Logo_Icon.png -resize 16x16 Hashgraph_Online.docset/icon.png |
| 69 | +magick /path/to/Logo_Icon.png -resize 32x32 Hashgraph_Online.docset/icon@2x.png |
| 70 | + |
| 71 | +# Create archive |
| 72 | +tar --exclude='.DS_Store' -cvzf Hashgraph_Online.tgz Hashgraph_Online.docset |
| 73 | +``` |
| 74 | + |
| 75 | +### What the Script Does |
| 76 | + |
| 77 | +1. Fetches documentation pages from hol.org (Docusaurus-based) |
| 78 | +2. Extracts main content and creates clean, readable HTML |
| 79 | +3. Creates a SQLite index (`docSet.dsidx`) for Dash search |
| 80 | +4. Generates an `Info.plist` with proper docset metadata |
| 81 | + |
| 82 | +## Indexed Content |
| 83 | + |
| 84 | +The docset includes: |
| 85 | +- **Registry Broker Documentation** - Agent discovery, chat, registration |
| 86 | +- **Standards SDK** - Core SDK for HCS standards |
| 87 | +- **HCS Standards** - 21+ protocol specifications (HCS-1 through HCS-21) |
| 88 | +- **API Reference** - Complete API client documentation |
| 89 | +- **Tutorials & Guides** - Getting started, MCP server setup, encrypted chat |
| 90 | + |
| 91 | +## Known Issues |
| 92 | + |
| 93 | +None currently. Please report issues at https://github.com/hashgraph-online/standards-sdk/issues |
| 94 | + |
| 95 | +## Links |
| 96 | + |
| 97 | +- **Website**: https://hol.org |
| 98 | +- **GitHub**: https://github.com/hashgraph-online |
| 99 | +- **npm**: `@hashgraphonline/standards-sdk` |
| 100 | +- **Telegram**: https://t.me/hashinals |
0 commit comments