Skip to content
Navigation

Primary

Internal errors

Docara checks not only the project but also itself: that its own component descriptions, templates and intermediate build data agree. These checks do not depend on the page text or settings; if such an error appears, the cause is not in your project.

What to do

  1. Run a full build again: docara build <environment>. Sometimes an interrupted earlier build causes the error.
  2. Check that Docara is installed completely and not changed by hand: composer install restores the package files from composer.lock.
  3. If the error repeats, report it in the Docara repository. Attach the code, the output of docara doctor --json and, if possible, the page on which the build stopped. Do not attach passwords or tokens.

Do not work around the error by editing the build result: the next build replaces it.

Internal check codes

Page parsing

The intermediate representation of a page that Docara builds before output.

Code What is checked
DOCUMENT_AST_EMPTY, DOCUMENT_AST_INVALID, DOCUMENT_IR_EMPTY, DOCUMENT_INPUT_INVALID The page is parsed into a non-empty valid structure
DOCUMENT_IR_SOURCE_LOCATION_INVALID, DOCUMENT_IR_SOURCE_NODE_TYPE_INVALID, DOCUMENT_SOURCE_SPAN_INVALID Every block has an exact place in the source file
DOCUMENT_HEADING_INVALID, DOCUMENT_LINK_INVALID, DOCUMENT_MARKDOWN_NODE_INVALID Headings, links and plain Markdown are parsed without loss
DOCUMENT_IR_COMPONENT_NODE_INVALID, DOCUMENT_IR_COMPONENT_BLOCK_NODE_INVALID, DOCUMENT_IR_CONTAINER_NODE_INVALID, DOCUMENT_COMPONENT_RENDERER_NODE_INVALID, DOCUMENT_COMPONENT_BLOCK_RENDERER_NODE_INVALID Blocks and components are passed to output in the expected form
DOCUMENT_SMART_CALL_NODE_INVALID, DOCUMENT_SMART_COMPONENT_NODE_INVALID, DOCUMENT_SMART_COMPONENT_ORDINAL_INVALID, DOCUMENT_SMART_VIEW_INVALID Smart component calls are numbered and passed to output whole
DOCUMENT_CONTAINER_CONTRACT_MISSING, DOCUMENT_CONTAINER_ORDER_INVALID, DOCUMENT_CONTAINER_SLOT_INVALID, DOCUMENT_CONTAINER_DEPTH_SEMANTICS_INVALID, DOCUMENT_CONTAINER_RENDERER_INVALID, DOCUMENT_CONTAINER_RENDERER_UNSUPPORTED, DOCUMENT_CONTAINER_CHILD_ARTIFACTS_REQUIRED The surface, grid and card have a full description of nesting
DOCUMENT_IR_RENDERER_UNKNOWN, DOCUMENT_IR_RENDERER_DUPLICATE Every block kind has exactly one way of output
DOCUMENT_OUTLINE_PARSE_FAILED, DOCUMENT_OUTLINE_SERIALIZE_FAILED The outline is built from the finished page

Page output

Code What is checked
PAGE_BUILDER_FAILED A wrapper around a page output error: the message after the colon gives the original cause. If it has another code, look for that code in this reference.
PAGE_BUILDER_DOCUMENT_ARTIFACT_REQUIRED, PAGE_BUILDER_DOCUMENT_IR_REQUIRED, RENDER_ARTIFACT_HTML_REQUIRED Every page got a parsed document and finished HTML
RESOLVED_BLOCK_PLAN_INVALID, RESOLVED_RENDER_PLAN_INVALID, RESOLVED_SMART_PLAN_INVALID, COMPOSITION_RECIPE_PAGE_RESULT_INVALID The page output plan is assembled in full
DECLARATIVE_BLOCK_RENDERER_UNSUPPORTED, DECLARATIVE_DOCUMENT_ELEMENT_INVALID, DECLARATIVE_DOCUMENT_MARKDOWN_INVALID, DECLARATIVE_DOCUMENT_NODES_REQUIRED, DECLARATIVE_DOCUMENT_NODE_INVALID, DECLARATIVE_DOCUMENT_NODE_RESOLVERS_REQUIRED, DECLARATIVE_DOCUMENT_NODE_RESOLVER_DUPLICATED, DECLARATIVE_DOCUMENT_RENDERERS_REQUIRED, DECLARATIVE_DOCUMENT_RENDERER_DUPLICATED, DECLARATIVE_DOCUMENT_SMART_INVALID, DECLARATIVE_REGION_SMART_INVALID The page template got all parts of the document and the regions
LAYOUT_DESCRIPTOR_INVALID, LAYOUT_REGION_INVALID, NAVIGATION_SCOPE_INVALID The description of the layout, its regions and navigation agree
SURFACE_SEMANTIC_FRAME_INVALID, SURFACE_SEMANTIC_PADDING_INVALID, SURFACE_SEMANTIC_TONE_INVALID, SURFACE_PADDING_2XL_REQUIRES_CONTAINER The styling of the surface and the first screen got checked values
MARKDOWN_HERO_EFFECT_ANCHOR_MISSING A first screen with a background effect has a place for the effect
SMART_INVOCATION_INVALID, SMART_TEMPLATE_CONTEXT_INVALID, SMART_CONTEXT_BRANDING_INVALID The Smart component template got a full set of data

Built-in Docara descriptions

Code What is checked
TYPED_COMPONENT_SOURCE_INVALID, TYPED_COMPONENT_DEFINITION_INVALID, TYPED_COMPONENT_DEFINITION_MISMATCH, TYPED_COMPONENT_DUPLICATE, TYPED_COMPONENT_RENDERER_UNKNOWN The Docara block descriptions are in place, do not repeat and match the output code
CONTENT_COMPONENT_REGISTRY_EMPTY, CONTENT_COMPONENT_DEFINITION_INVALID, CONTENT_COMPONENT_TEMPLATE_INVALID, CONTENT_COMPONENT_ALIAS_INVALID, CONTENT_COMPONENT_ALIAS_MISMATCH, CONTENT_COMPONENT_PROP_CONTRACT_INVALID, CONTENT_COMPONENT_SLOT_CONTRACT_INVALID, CONTENT_COMPONENT_NORMALIZATION_INVALID The inline component descriptions are valid
SCHEMA_INVALID, SCHEMA_NOT_FOUND The settings schemas are in the package and readable
NATIVE_MARKDOWN_PROFILE_INVALID The set of supported Markdown constructs matches the enabled extensions
DOCARA_AI_CONTRACT_INVALID, DOCARA_AI_CONTRACT_MISSING The description of features for an AI agent is in the package
SDK_RESULT_CONTRACT_INVALID The answer of a command with --json matches its schema
TARGET_SITE_JSON_FORBIDDEN, TARGET_PUBLIC_INPUT_FORBIDDEN, TARGET_COMPOSITION_KIND_INVALID, TARGET_CONFIG_PROSE_FORBIDDEN, TARGET_COMPONENT_PROSE_FORBIDDEN Package files do not get into the site input, and page text is not kept in component settings

Shell assembly and catalogues

What is checked Codes
The component catalogue is assembled in full: every component has an owner, a source, checked variants and honest limits COMPONENT_CATALOG_DUPLICATE_ID, COMPONENT_CATALOG_ENTRY_INVALID, COMPONENT_CATALOG_FAMILY_CONTRACT_INVALID, COMPONENT_CATALOG_GAP_INCOMPLETE, COMPONENT_CATALOG_GAP_OWNER_REQUIRED, COMPONENT_CATALOG_HASH_MISMATCH, COMPONENT_CATALOG_ID_INVALID, COMPONENT_CATALOG_MANIFEST_REFERENCE_MISMATCH, COMPONENT_CATALOG_METADATA_INVALID, COMPONENT_CATALOG_ORDER_INVALID, COMPONENT_CATALOG_OVERCLAIM_FORBIDDEN, COMPONENT_CATALOG_PATH_INVALID, COMPONENT_CATALOG_PROVENANCE_UNSAFE, COMPONENT_CATALOG_PROVIDER_REVISION_MISMATCH, COMPONENT_CATALOG_PUBLIC_SLUG_INVALID, COMPONENT_CATALOG_REFERENCE_MISSING, COMPONENT_CATALOG_REQUIREMENT_EXECUTABLE_FORBIDDEN, COMPONENT_CATALOG_SMART_ADMISSION_MISMATCH, COMPONENT_CATALOG_SMART_CONSTRAINTS_INVALID, COMPONENT_CATALOG_SMART_METADATA_INVALID, COMPONENT_CATALOG_SMART_METADATA_PROVENANCE_FORBIDDEN, COMPONENT_CATALOG_SMART_METADATA_WIDENS_MANIFEST, COMPONENT_CATALOG_SMART_POLICY_MISMATCH, COMPONENT_CATALOG_SMART_PROP_ENUM_INVALID, COMPONENT_CATALOG_SMART_PROP_INVALID, COMPONENT_CATALOG_SMART_PROP_RULE_INVALID, COMPONENT_CATALOG_SMART_PROP_TYPE_UNSUPPORTED, COMPONENT_CATALOG_SMART_PROVENANCE_MISMATCH, COMPONENT_CATALOG_SOURCE_INVALID, COMPONENT_CATALOG_SUPPORTED_EVIDENCE_REQUIRED, COMPONENT_CATALOG_UNSUPPORTED_DEMO_FORBIDDEN, COMPONENT_CATALOG_VARIANT_COVERAGE_MISMATCH, COMPONENT_CATALOG_VARIANT_COVERAGE_REQUIRED, COMPONENT_SOURCE_METADATA_HASH_MISMATCH, COMPONENT_SOURCE_METADATA_INVALID, COMPONENT_SOURCE_METADATA_MISSING, COMPONENT_SOURCE_METADATA_ORDER_INVALID, COMPONENT_SOURCE_METADATA_REFERENCE_MISSING
Shell templates, their data and the connection of styles DECLARATIVE_BLADE_CACHE_UNAVAILABLE, DECLARATIVE_BLADE_COMPILE_FAILED, DECLARATIVE_DEFINITION_INVALID, DECLARATIVE_DEFINITION_MISSING, DECLARATIVE_DOCUMENT_NODE_CONTRACT_INVALID, DECLARATIVE_DOCUMENT_NODE_UNSUPPORTED, DECLARATIVE_DOCUMENT_RENDERER_UNSUPPORTED, DECLARATIVE_GENERATED_ASSET_INVALID, DECLARATIVE_GENERATED_ASSET_PUBLICATION_FAILED, DECLARATIVE_MOBILE_TOC_HEADING_CONTRACT_INVALID, DECLARATIVE_NAVIGATION_NODE_INVALID, DECLARATIVE_OUTLINE_ITEM_INVALID, DECLARATIVE_PORTABLE_TEMPLATE_CONTEXT_INVALID, DECLARATIVE_PRIMARY_ASSET_BASE_INVALID, DECLARATIVE_PRIMARY_COPY_REQUIRED, DECLARATIVE_PRIMARY_INPUT_REQUIRED, DECLARATIVE_PRIMARY_REGIONS_REQUIRED, DECLARATIVE_PUBLISHER_ASSET_INVALID, DECLARATIVE_PUBLISHER_ASSET_MISSING, DECLARATIVE_PUBLISHER_ASSET_PUBLICATION_FAILED, DECLARATIVE_RENDERED_CONTENT_PARITY_FAILED, DECLARATIVE_SHELL_ASSET_MISSING, DECLARATIVE_SHELL_STYLESHEET_LINKS_INVALID, DECLARATIVE_SMART_ASSET_INVALID, DECLARATIVE_SMART_ASSET_MISSING, DECLARATIVE_SMART_ASSET_PUBLICATION_FAILED, DECLARATIVE_SMART_PROVIDER_UNAVAILABLE, DECLARATIVE_TEMPLATE_CONTEXT_INVALID, DECLARATIVE_TEMPLATE_EMPTY, DECLARATIVE_TEMPLATE_NOT_ALLOWED, DECLARATIVE_TEMPLATE_UNSAFE, DECLARATIVE_THEME_ASSET_INVALID, DECLARATIVE_VIEW_IDENTITY_INVALID, DECLARATIVE_VIEW_REGION_UNRESOLVED, DECLARATIVE_VIEW_SLOT_UNRESOLVED, DECLARATIVE_VIEW_UTILITY_REGISTRY_INVALID, DECLARATIVE_VIEW_UTILITY_REGISTRY_MISSING, PORTABLE_LOCAL_ASSET_RECEIPT_INVALID
The Smart component registry and the ways of output SMART_CONTEXT_ADAPTER_DUPLICATE, SMART_CONTEXT_ADAPTER_UNKNOWN, SMART_PROVIDER_ADAPTER_INVALID, SMART_PROVIDER_DESCRIPTOR_MISMATCH, SMART_PROVIDER_DUPLICATE, SMART_PROVIDER_RESOLVER_DUPLICATE, SMART_REGISTRY_ASSET_NOT_FOUND, SMART_REGISTRY_DUPLICATE_ALIAS, SMART_REGISTRY_DUPLICATE_ASSET, SMART_REGISTRY_DUPLICATE_COMPONENT, SMART_REGISTRY_KEY_MISMATCH, SMART_REGISTRY_TEMPLATE_NOT_FOUND, SMART_RENDER_STRATEGY_DUPLICATE, SMART_RENDER_STRATEGY_UNKNOWN, SMART_TEMPLATE_ABI_UNKNOWN
The registry of data bindings and built-in design descriptions BINDING_ALIAS_COLLISION, BINDING_DESCRIPTOR_INVALID, BINDING_DUPLICATE, BINDING_NAMESPACE_COLLISION, BINDING_NAMESPACE_FORBIDDEN, BINDING_NAMESPACE_INVALID, BINDING_PROVENANCE_INVALID, BINDING_PROVIDER_DUPLICATE, BINDING_RESOLVER_OUTPUT_FORBIDDEN, DESIGN_PROVIDER_DUPLICATE, DESIGN_PROVIDER_INVALID, DESIGN_PROVIDER_NAMESPACE_INVALID
A repeated check of the icon, badge, button, key and alert (usually a MARKDOWN_… code from Page and Markdown errors fires earlier); the content language, the settings reference and the reader settings CONTENT_COMPONENT_BLOCK_CONTENT_REQUIRED, CONTENT_COMPONENT_BLOCK_HEADING_REQUIRED, CONTENT_COMPONENT_DOCUMENT_BODY_REQUIRED, CONTENT_COMPONENT_INLINE_BODY_FORBIDDEN, CONTENT_COMPONENT_SLOT_REQUIRED, CONTENT_COMPONENT_UNKNOWN, CONTENT_LANGUAGE_ROOT_INVALID, PUBLIC_SCHEMA_DESCRIPTIONS_INVALID, PUBLIC_SCHEMA_REFERENCE_INVALID, PUBLIC_SCHEMA_REFERENCE_UNKNOWN, READER_PREFERENCE_DUPLICATE, READER_PREFERENCE_UNKNOWN

Marks of passed checks

docara doctor, docara validate and their --json output also list the checks that passed, with the status pass. These are not errors: there is nothing to fix.

Code What passed the check
PROJECT_CONFIG_VALID The project settings
SCHEMA_CATALOG_VALID The catalogue of settings schemas
SMART_REGISTRY_VALID, DESIGN_REGISTRY_VALID, BINDING_REGISTRY_VALID The lists of Smart components, design descriptions and bindings; their count is shown beside them
DESIGN_ARTIFACT_VALID One design description
PAGE_MARKDOWN_VALID The Markdown of one page
DOCUMENTATION_SOURCES_VALID, DOCUMENTATION_SOURCE_VALID Documentation tracking sources: all of them and one
PROJECT_REGISTRIES_VALID All project registries together; the number of components and design descriptions is shown beside it
COMPOSITION_EXPANDED, SAFE_VIEW_TREE_VALIDATED The page frame is assembled from regions, and its tree passed the tag and attribute check
AUTHOR_EXECUTABLE_SURFACES With the status absent: the page settings have no templates or code

See also