NEXUS

Documentation

Nexus Docs is where MiCamp's product documentation lives: what each product does and who uses it, how to set it up and run it, the APIs it serves and calls, the documents behind it, and what changed in each release. New to a product? Start with its getting-started guide.

Products

Getting started

New to a product? Its guide takes you from nothing to running it locally and taking a first step with it.

What each product's docs cover

Every product has the same pages, in the same order, so you know where to look.

  1. Product OverviewWhat the product does, who it is for, and how it fits Nexus.
  2. Getting StartedSet it up, run it locally, and take a first step with it.
  3. APIsEndpoints, authentication, and integration guides.
  4. DocumentsSpecifications, agreements, and formal documentation.
  5. ResourcesSDKs, tooling, examples, and support material.
  6. Release NotesWhat shipped, what changed, and what is deprecated.

How these docs are written

Each product's pages are written from its source code and the documents in its repository. When older documents and the code disagree, the pages follow the code and point out the difference.

Getting-started guides name the branch and commit their steps were checked against, and the date, right under the title. If a step no longer works, that line tells you how old it is.

Service status and incidents

Live health for every product, incidents and planned maintenance are on the status page. You can subscribe to updates by email there, and use Report an issue when something is wrong that nobody has flagged yet.

Security issues

Found a vulnerability in a MiCamp product? Report it through the bug bounty program, not through public channels.