Logo
NeoArc Studio

Source Control Native

Everything in NeoArc Studio is a file. Your diagrams, documents, and schemas live in Git alongside your code, with full version history and standard collaboration workflows.

NeoArc Studio takes a different approach. Everything you create is a text-based JSON file stored in your Git repository. Your diagrams, design documents, API specifications, schemas, and decision records sit alongside your code in the same folder structure you already use.

Why This Matters

Full Version History
Every change to every document is tracked in Git. See exactly who changed what, when, and why. Roll back to any previous version. Compare versions side by side.
Branch and Merge
Create a feature branch for your documentation changes just like you would for code. Work on updates without affecting the main branch. Merge when ready.
Code Review for Documentation
Documentation changes go through the same pull request process as code. Reviewers can see exactly what changed in the diff. Comments are tracked in your existing system.
Documentation Stays with Code
When documentation lives in the same repository as the code it describes, they stay synchronised naturally. Update both in the same commit.

File Formats

All NeoArc content uses human-readable JSON files with clear extensions:

ExtensionContent Type
.cf.page.jsonDocumentation pages
.diagram.jsonArchitecture diagrams
.graph-diagram.jsonGraph diagrams
.schema.jsonData schemas
.projection.jsonProjections (database, search, schema, API and UI mappings from the canonical model)
.data-view.jsonData views (persistence and search views of the model)
.adr.jsonArchitecture decision records

No Vendor Lock-in

CI/CD Integration

Because your documentation is just files in Git, you can integrate it into your existing CI/CD pipelines:

Validate on Commit
Validate documentation structure on every commit to catch issues early.
Auto-Publish
Publish automatically when changes merge to main.
Custom Checks
Run custom scripts to check for broken links or missing content.

Works with Your Existing Infrastructure

NeoArc Studio works with any Git provider: GitHub, GitLab, Azure DevOps, Bitbucket, or self-hosted Git servers. Your documentation benefits from whatever security, access controls, and compliance features you already have in place for your code repositories.

The Documentation Workflow That Actually Works

Baseline-Driven API Comparison

Baselines do more than track general drift. When you compare against a baseline, the system classifies every API contract change as breaking, additive, deprecation, or cosmetic across all API types (REST, GraphQL, gRPC, AsyncAPI, Webhooks, MCP). The drift dashboard shows API contract drift alongside architectural drift, and the system recommends version bumps based on change severity.

Classified Changes
Every change is classified by impact: breaking changes that affect consumers, deprecations, new additions, and cosmetic documentation updates.
Published Changelogs
Changelogs are included automatically when you publish your documentation site. Consumer teams can browse version history and classified changes without repository access.
Per-Resource Approval
When creating a baseline, select which APIs and schemas you are formally approving. Impact analysis for each resource compares against the baseline where it was last approved, not just the most recent baseline.