Skip to content

docs: switch install/quickstart to npm distribution#8

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/2ae70a19
Open

docs: switch install/quickstart to npm distribution#8
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/2ae70a19

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 2, 2026

Copy link
Copy Markdown

Summary

Reworks the install and quickstart docs to lead with the new npm distribution (npm install -g @meridiona/meridian && meridian setup) and keeps the source-clone flow as a contributor alternative.

Changes

  • Quickstart rewritten around npm install + meridian setup, with a Gatekeeper bypass note for unsigned v1 builds and a contributor-only "build from source" section at the bottom.
  • Introduction system requirements collapsed to macOS Apple Silicon + Node — the prebuilt bundle removes Rust/Python build steps for end users.
  • Home page three-step flow updated to npm.
  • Configuration / Environment Variables: config path moved from ~/.meridian/.env to ~/.meridian/app/.env; removed the now-defunct second env file and OpenRouter helper.
  • CLI reference: added meridian setup and meridian update entries, scoped the install.sh flags section to source builds, updated the launchd service list (no more jira-updater / coding-agent-indexer), updated doctor checks, refreshed meridian permissions to two panes (audio is disabled).
  • Troubleshooting: replaced Rust/Python build-failure cases with Gatekeeper bypass and command not found guidance; source-build issues kept under a single contributor-scoped accordion.
  • Guides (Jira, MCP setup, dashboard, github-linear): updated env paths, dashboard port (3939), and MCP server bundle path (~/.meridian/app/packages/meridian-mcp/dist/index.js).
  • Mentions that the bundle ships prebuilt binaries — no Rust/Python build step on the user's machine.

Context

Source PRs that introduced the npm distribution:

@mintlify

mintlify Bot commented Jun 2, 2026

Copy link
Copy Markdown
Author

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

Project Status Preview Updated (UTC)
meridiona 🟢 Ready View Preview Jun 2, 2026, 7:17 AM

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.

0 participants