concept · platform overviewPublicVersion current

Getting started with ClearPoint Docs

ClearPoint Docs is the documentation portal for ClearPoint Logic. It publishes source-anchored documentation for people and agents who need to understand the platform, its operating model, and the product documentation that is ready for its audience.

What this covers

This page explains which reader tiers the portal supports, how publication stays tied to an approved source, and how to find material that your audience may read.

How it works

The portal uses audience tiers so each page is published only to the readers its source owner approved:

  • Public pages explain the portal, high-level product documentation, and other material approved for anonymous readers.
  • Customer pages are available only after sign-in under an organization that is allowed to read them.
  • Developer and partner pages require organization membership and the corresponding server-side audience grant.
  • Internal pages are restricted to ClearPoint internal roles for runbooks, architecture, handover, and operating evidence.

No developer or partner page publishes until its source owner approves the content and audited grant fixtures plus live access checks prove both allowed and denied reads. A page does not publish to a tier the runtime gate cannot enforce.

Limits

Every published page carries a source_anchor back to its authoring source of truth, an owner, and a review timestamp. The corpus gate checks those fields before publication, and the reconciliation sweep records the source owner's freshness, claim, and classification review for each page.

Next steps

Use the route index, search API, and agent-readable document identifiers to find the pages your audience can read. Search results are filtered by the same audience gate as direct page reads, so restricted titles are not listed for anonymous readers.

Terms used on this page

Report a problem with this page

Do not include secrets or customer data.


Doc ID
cpl.docs.getting_started
Source
docs/canonical/CPD-DOCS-CANONICAL.md#definition
Updated