Documentation
Nautilus's documentation is open and lives where the engineers can find it. This page is the index. The actual documentation is in the repository (under docs/) and rendered through the public docs portal.
What's in the docs
Specifications
- Requirements & features specification (
docs/requirements-and-features.md) — the formal spec document, current authoritative scope. Domains, functional + non-functional requirements, integration architecture, licensing, glossary. Currently v0.16. - Tier-C integration specs (
docs/integrations/) — published interface specifications for third-party integrators. Spec text CC BY 4.0; conformance harnesses Apache 2.0. Currently live: ship-PBX (Draft v0.1). - Architectural decision records (
docs/adr/) — public ADRs covering bus, database, gateway, networking, frontends, comms platform, content safety, and licensing decisions.
Developer documentation
- Local development guide —
docker-composesetup, mock services, smoke tests. - Repository structure — domain layout, frontend layout, platform layout.
- Contribution guide (
CONTRIBUTING.md) — how to contribute, review process, commit conventions. - Security disclosure policy (
SECURITY.md) — how to report security issues. - Code of conduct (
CODE_OF_CONDUCT.md). - CLA (
CLA.md) — contributor license agreement.
API references
- Domain APIs — REST + event contracts per domain. Generated from OpenAPI + AsyncAPI definitions in the repository.
- Bus subject contracts — JetStream subject and stream definitions per Tier-A spec.
- Tier-C interface APIs — endpoint and subject contracts per published spec.
Integration guides
- CRS integration — Versonix Seaware reference adapter walkthrough.
- Legacy PBX retrofit — implementing against the ship-PBX Tier-C spec.
- Payment processor adapter — Stripe reference adapter walkthrough; Adyen on demand.
- GRMS adapter (coming with the Tier-C spec) — KNX / BACnet / DALI adapter authoring.
- Content safety integration (coming with the Heimdall API spec) — calling
/analyzeand/moderatefrom a tenant service.
Operator documentation
- CMS user guide — operator admin functions.
- Fleet console guide — Domain 12 operations.
- signsync content management guide — Domain 15.C signage.
- Crew app training material — Domain 14 + Domain 6 + Domain 5.
- Compliance package authoring — DPIA, retention, jurisdictional handling.
Where the docs live
- Repository: gitlab.com/ntcorp/devlab/nautilus/design
- Public docs portal: TBD — site team picks GitBook / Mintlify / similar
- Issue tracker: gitlab.com/ntcorp/devlab/nautilus/design/-/issues
- Public roadmap: gitlab.com/ntcorp/devlab/nautilus/design/-/issues
- OSS community: TBD — Discord / Matrix / Slack
Where to start, by role
| Role | Start here |
|---|---|
| Cruise operator IT director | Architecture page, then Requirements & features spec §1–6, then Phasing |
| System integrator | docs/integrations/README.md, then ship-PBX spec, then conformance harness setup |
| Backend engineer (contributor) | CONTRIBUTING.md, then ADRs, then a domain readme + good-first-issues |
| Frontend engineer (contributor) | CONTRIBUTING.md, then frontends/pwa/README.md and frontends/mobile/README.md |
| Hardware partner | Architecture page → Tier-C specs → integrator partnership program |
| Press / analyst | Home → Open source → About NT Connect |
| Security researcher | SECURITY.md → architecture → Tier-A audit reports |
Browse the repo → Browse Tier-C specs → For developers → For integrators →