Core ConceptsConcepts

Core Concepts

Explanation of the platform's core concepts, architecture, and how documentation is structured.

Overview

CODE IN CO SOLUTIONS provides a flexible documentation platform where you organize knowledge across projects. You create spaces to group related documentation, manage hierarchies for structured content, and collaborate seamlessly. This page covers the foundational elements: spaces and projects, document structure, versioning, sharing, publishing, and scaling options.

Familiarize yourself with these concepts before diving into advanced workflows.

Key Concepts

Use these building blocks to structure your documentation effectively.

Document Hierarchy and Versioning

Documents form a tree structure. You nest pages under parents, creating paths like /spaces/my-space/projects/my-project/docs/intro.

Versioning tracks changes automatically. You branch documents like code, merge updates, and tag releases.

Active editing happens here. Preview changes before merging.

Collaboration and Sharing Model

Invite team members to spaces or projects with granular permissions: view, edit, admin.

Invite Collaborators

Go to space settings and add emails or teams.

Set Permissions

Assign roles: Viewer, Editor, Maintainer.

Share Publicly

Generate read-only links or embed previews.

Use role-based access to prevent accidental changes in production docs.

Publishing Pipelines

Automate deployments from branches to custom domains.

# Publish main branch
codeinco publish --space my-space --branch main --domain docs.codeinco.tech

Customize pipelines with webhooks for CI/CD integration.

Scalability and Customization

Scale to thousands of documents with search indexing and CDN delivery. Customize themes via YAML configs.

path
spaceIdstring
Required

Unique space identifier for API calls.

header
Authorizationstring
Required

Bearer token for authenticated requests.

Next Steps

Planning
1

Define structure

Outline spaces and projects

Drafting
1

Write content

Use MDX for rich docs

Dec 15, 2024
Review
1

Collaborate

Publish
1

Deploy live