Skip to content

docs: YourSSH user and developer guides - #1

Merged
thangnm93 merged 3 commits into
mainfrom
feature/user-guide
Nov 13, 2026
Merged

thangnm93 merged 3 commits into
mainfrom
feature/user-guide

Conversation

@thangnm93

Copy link
Copy Markdown
Contributor

Replaces the Mintlify starter with the YourSSH documentation.

  • Content (25 pages):
    • User guide: get started (introduction, installation, quickstart), connections (hosts, host keys, terminal, terminal sharing, bulk actions, port forwarding), SFTP, RDP/VNC, security (keychain, recording, audit log), tools (snippets, AI chat, DevOps Hub, Web Tools, CLI and yourssh:// links), settings, sync and Android.
    • Developer guide: architecture, build, contributing, plugin system, plugin authoring.
    • Sources: the pages are ported from the app repo's wiki and refreshed for 0.4.0. Two reviewers fact-checked them against develop. Mismatches they found in the app were fixed there: YoursshLabs/yourssh #126, #127 and #128, with the mobile app-lock fix in progress.
  • Screenshots: 125 images from the app's isolated docs journey (tool/docs_journey.sh) with demo data only, resized to 1440 px. QR codes carry the documentation address 192.0.2.10.
  • Branding: amber palette, YourSSH logo and favicon, Lucide icons, dark by default.
  • CI (.github/workflows/docs.yml):
    • Every PR and push runs mint validate and mint broken-links.
    • On main, the workflow then triggers the Mintlify deployment through the API and waits for it.
    • The deploy needs the MINTLIFY_API_KEY and MINTLIFY_PROJECT_ID secrets; without them it is skipped with a warning.
    • Static export (GitHub Pages) needs the Mintlify Enterprise plan, so the hosted deployment is used.
  • Repo docs: README, CONTRIBUTING and AGENTS.md (style and terminology) are rewritten. Task notes are in .docs/user-guide-site/ and are not published.

https://claude.ai/code/session_01YGAGXFNiYwvqiuiRKg25y2

Replaces the Mintlify starter with the YourSSH documentation: branding
(amber palette, logo, favicon, Lucide icons), a User guide tab (get
started, connections, files, remote desktop, security, tools, settings
and sync, Android) and a Developer guide tab, ported from the app repo's
wiki, refreshed for 0.4.0 and fact-checked against the code, with
screenshots from the isolated docs journey. CI validates the build and
links on every PR and deploys to Mintlify from main.
@mintlify

mintlify Bot commented Nov 13, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
your-ssh 🟡 Building – Nov 13, 2026, 8:42 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@thangnm93
thangnm93 merged commit c55cac9 into main Nov 13, 2026
5 checks passed
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