Source of the YourSSH documentation site, built with Mintlify.
Live site: https://yoursshlabs.com
The app lives in YoursshLabs/yourssh.
npx mint dev # http://localhost:3000
npx mint validate # the same build check CI runs
npx mint broken-linksRequires Node.js 20.17 or newer.
docs.json— site config and navigation. A page must be listed here to be published.index.mdx,installation.mdx,quickstart.mdx— getting started.user-guide/— one page per feature.developer-guide/— building from source, architecture and plugins.images/<NN-section>/— screenshots from the app repo's isolated docs journey (tool/docs_journey.sh), resized to at most 1440 px wide.
Writing rules and terminology: AGENTS.md.
release-notes.mdx is generated by scripts/gen_release_notes.py from the app's CHANGELOG.md at the latest release (0.2.0 and later). .github/workflows/release-notes.yml runs every six hours, on demand, or on a yourssh-release repository dispatch from the app's release workflow: it regenerates the page, runs mint validate and mint broken-links, opens a pull request, runs Build and check on it, merges it and starts the deployment. Don't edit the page by hand; fix the CHANGELOG instead.
.github/workflows/docs.yml:
- Every pull request and every push to
mainrunmint validateandmint broken-links. - After those pass on
main, the workflow asks Mintlify to deploy the site and waits for the result. It uses the repository secretsMINTLIFY_API_KEY(an admin API key,mint_…) andMINTLIFY_PROJECT_ID, both from the Mintlify dashboard's API keys page. Without them the deploy step is skipped with a warning.
main is protected: changes land through pull requests, and the Build and check job must pass before merging.
The Mintlify GitHub App also deploys on every push to main. To make CI the only way the site deploys, turn off automatic deployments for this repository in the Mintlify dashboard.