Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

The Document Details page (/documents/:id) provides a full management interface for a single document, including its metadata, file versions, approval workflow, permissions, and a document preview.

​
Overview

The page loads the document via useDocumentDetail with the :id parameter, and fetches versions via useDocumentVersions. It uses useDocumentDownload for file downloads and useDocumentMutation for status changes. The UI is tabbed with sections for the document preview (DocumentPreview), approval workflow (ApprovalTimeline, ApprovalWorkflowSetup), and permissions (PermissionsManager). Users can upload a new version via UploadVersionDialog and change the document status via a Select control. Approval decisions are handled via DocumentApprovalDecisionDialog. Status badge colours correspond to the current DocumentStatus enum value.

​
Who it’s for

No explicit permission gate on this route. Access control depends on document-level permissions managed via PermissionsManager.

​
Before you start

  • Navigate to this page from the Documents library (/documents).
  • Document-level permissions determine which tabs and actions are visible.

​
Steps

1

Open a document

From /documents, click a document to navigate to /documents/:id.
2

Preview the document

The default view shows the document preview rendered by DocumentPreview.
3

Change document status

Use the status Select control in the header to change the document’s lifecycle status (e.g., from draft to in_review).
4

Upload a new version

Click the upload action to open UploadVersionDialog and attach a new file version.
5

Manage approvals

Switch to the Approvals tab to view the ApprovalTimeline and configure steps via ApprovalWorkflowSetup. Use DocumentApprovalDecisionDialog to approve or reject.
6

Manage permissions

Switch to the Permissions tab to use PermissionsManager to control who can view or edit the document.
7

Download the document

Click the download action to trigger useDocumentDownload and retrieve the file.

​
Key concepts

Statuses include draft, in_review, pending_approval, approved, rejected, published, and archived. Each has a distinct badge colour defined in STATUS_COLORS.
Document versions are tracked separately from the base document record. Each upload creates a new version entry.

Platform Foundation

Platform Foundation overview.

Governance & parity

Documentation coverage and governance.
This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/platform.tsx
  • src/platform/documents/DocumentDetailPage.tsx
  • src/platform/documents/useDocumentDetail.ts
  • src/platform/documents/hooks/useApprovalWorkflow.ts