Skip to content

docs: add step-by-step user guides with screenshots#38

Merged
rprabhat merged 2 commits intomainfrom
docs/explorer-signing-guides
Apr 7, 2026
Merged

docs: add step-by-step user guides with screenshots#38
rprabhat merged 2 commits intomainfrom
docs/explorer-signing-guides

Conversation

@rprabhat
Copy link
Copy Markdown
Collaborator

@rprabhat rprabhat commented Apr 7, 2026

Summary

Add comprehensive step-by-step guides for all three user types with screenshots and examples:

New Guides Added

  1. Explorer Quick Start (docs/getting-started/explorer-guide.md)

    • Step-by-step for non-technical users
    • Screenshots: Home, Graph, Chat, Report views
    • How to download, install, add folder, chat with documents
    • Offline/private messaging
  2. Developer Quick Start (docs/getting-started/developer-guide.md)

    • CLI installation from source
    • Project initialization
    • Schema definition example
    • Query writing example
    • HTTP client code snippets
  3. AI Agent Integration (docs/getting-started/agent-guide.md)

    • Architecture diagram
    • Schema examples for memory/context
    • Python and TypeScript code examples
    • MCP integration coming soon note

Technical Changes

  1. entitlements.plist - macOS hardened runtime entitlements required for notarization
  2. tauri.conf.json - Updated signing config, entitlements path, minimum macOS version
  3. explorer-release.yml - Added signing/notarization steps with GitHub secrets support
  4. mkdocs.yml - Updated navigation with new guide sections

App Signing

The app currently shows "broken" because it's not signed. This PR adds the infrastructure for signing but requires:

  • Apple Developer account ($99/year)
  • GitHub secrets for APPLE_CERTIFICATE, APPLE_ID, etc.

For now, users can right-click > Open to bypass Gatekeeper on unsigned apps.

Testing

rprabhat added 2 commits April 7, 2026 14:08
- Add Explorer Quick Start guide (non-technical users) with screenshots
- Add Developer Quick Start guide with code examples
- Add AI Agent Integration guide with Python/TypeScript examples
- Add entitlements.plist for macOS signing
- Update tauri.conf.json for signing and hardened runtime
- Update explorer-release.yml workflow with signing support
- Update mkdocs nav with new guides sections
@rprabhat rprabhat merged commit 4217144 into main Apr 7, 2026
7 of 8 checks passed
@rprabhat rprabhat deleted the docs/explorer-signing-guides branch April 7, 2026 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant