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.
Documentation Spaces
Group projects and documents into isolated spaces for teams or clients.
Projects
Organize documents within spaces, with built-in versioning and history.
Document Hierarchy
Nest pages and subpages for intuitive navigation and SEO-friendly URLs.
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.
Stable versions like v1.0 for publishing.
Fork for experiments without affecting main content.
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
// API publish
const response = await fetch('https://api.example.com/v1/publish', {
method: 'POST',
headers: { Authorization: `Bearer ${YOUR_TOKEN}` },
body: JSON.stringify({
spaceId: 'space-123',
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.
Unique space identifier for API calls.
Bearer token for authenticated requests.
Next Steps
Define structure
Outline spaces and projects
Write content
Use MDX for rich docs
Collaborate
Deploy live