docs: Mintlify site for openscience.sh/docs#86
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Aayam Bansal (aayambansal)
added a commit
that referenced
this pull request
Jul 5, 2026
* Revert "docs: Mintlify site for openscience.sh/docs (#86)" This reverts commit c3bbd74. * docs: OpenScience docs site for openscience.sh/docs Replace the docs package with a small Vite + React app that renders the OpenScience MDX pages as a hash-routed single-page site. - Guides and CLI reference for OpenScience only: index, quickstart, workspace, agents, models, skills, sessions, atlas, commands, security. - Served under openscience.sh/docs (Vite base /docs/, SPA rewrite in vercel.json); assets and fonts resolve beneath /docs/. - OpenScience wordmark, favicon, and a Star on GitHub call to action. - typecheck (tsc --noEmit) and the CI docs build both pass. * docs: use the working openscience.sh/install URL in quickstart
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
New Mintlify documentation site in a top-level
docs/directory, ported from the Astro docs content infrontend/docs/src/content/docs/and corrected against the current repo. The Astro site is untouched in this PR. Validated withnpx mint validate(build validation passed) andnpx mint broken-links(no broken links).Fixes #37
Pages
index- what OpenScience is, plus a quickstartinstallation- install script, package managers, launcher, Windows, binaries, upgrade/uninstallconfig- openscience.json format, locations, precedence, all options, variablesmodels- model selection, defaults, variants, loading orderproviders- credentials, Atlas, provider directory, local models, custom providerspermissions- allow/ask/deny, granular rules, external directories, defaultsrules- AGENTS.md, locations, precedence, custom instructionsthemes- built-in themes, system theme, custom theme JSONagents- primary agents, subagents, built-ins, JSON/markdown config, all optionstools- built-in tools and how permissions govern themmcp-servers- local/remote servers, OAuth, per-agent management, examplesskills- SKILL.md locations, discovery, frontmatter, permissionsatlas- connect login, the two credential stores, wallet billing, spend modesshare- sharing modes, unsharing, privacycli- full command reference including connect/billing, global flags, env varstroubleshooting- logs, storage, common errorscontributing- pointer to CONTRIBUTING.md, repo layout, dev workflowPlus
docs.json(mint theme, teal#0d9488primary, dark default, GitHub/npm anchors), the wordmark logo, favicon, and a 3-linedocs/README.md.Content corrections applied while porting
ghcr.io/synthetic-sciences/opensciencedoes not exist (Docs quickstart documents a Docker image that doesn't exist #37). Marked Mise as community-maintained and untested.curl -fsSL https://openscience.sh/install | bash; npm isnpm install -g @synsci/openscience; launcher isnpx synsci.$schemaexample now useshttps://openscience.sh/config.json(wassyntheticsciences.ai/config.json)../backend/cli/dist/@synsci/openscience-<platform>/bin/openscience; repo layout documented asfrontend/ backend/ tooling/withmainas the default branch.openscience auth loginkeys stay local inauth.jsonand are never uploaded;openscience connect loginstores athk_session key and pulls dashboard-connected credentials down; local keys win over synced ones; the spend toggle (billing.llm/billing.compute, managed vs byok) governs wallet gating, not which key is used.connect(login/status/sync/devices/logout) andbilling(show/topup) CLI commands, which were missing from the old CLI reference.To go live
docs/as the content directory (branchmainafter merge)/docsrewrite at the Mintlify deploymenthttps://openscience.sh/docsrenders and cross-links resolve