Skip to content

Commit e45d073

Browse files
mfriesenmfriesen
authored
Restructure docs and expand FormKiQ guides
- Replace autogenerated docs sidebar with curated documentation sections - Add category landing pages for getting started, features, tutorials, operations, troubleshooting, and changelog - Add new how-to guides for user/group management, API keys, sharing, webhooks, OCR search, audit reporting, and versioning - Add new tutorials for scalable architecture, review workflows, OCR archives, event-driven processing, and Java document APIs - Refresh feature, platform, SDK, tutorial, and operations documentation - Add redirects for renamed API reference and error handling categories - Initialize gtag dataLayer support in Docusaurus config
1 parent 9c8a5c8 commit e45d073

96 files changed

Lines changed: 12552 additions & 5505 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/category-pages/category-page.module.css‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
.introPanel {
2+
background: var(--ifm-color-emphasis-100);
3+
border: 1px solid var(--ifm-color-emphasis-200);
4+
border-radius: 8px;
5+
margin: 1.25rem 0 2rem;
6+
padding: 1.5rem;
7+
}
8+
9+
.introPanel p {
10+
color: var(--ifm-color-emphasis-800);
11+
font-size: 1.05rem;
12+
margin: 0;
13+
}
14+
15+
.cardGrid {
16+
display: grid;
17+
gap: 1rem;
18+
grid-template-columns: repeat(2, minmax(0, 1fr));
19+
margin: 1.5rem 0 2rem;
20+
}
21+
22+
.wideGrid {
23+
display: grid;
24+
gap: 0.85rem;
25+
grid-template-columns: repeat(3, minmax(0, 1fr));
26+
margin: 1.5rem 0 2rem;
27+
}
28+
29+
.card,
30+
.compactCard {
31+
border: 1px solid var(--ifm-color-emphasis-200);
32+
border-radius: 8px;
33+
color: var(--ifm-font-color-base);
34+
display: block;
35+
text-decoration: none;
36+
}
37+
38+
.card {
39+
min-height: 170px;
40+
padding: 1.25rem;
41+
}
42+
43+
.compactCard {
44+
min-height: 112px;
45+
padding: 1rem;
46+
}
47+
48+
.card:hover,
49+
.compactCard:hover {
50+
border-color: var(--ifm-color-primary);
51+
color: var(--ifm-font-color-base);
52+
text-decoration: none;
53+
}
54+
55+
.card h2,
56+
.compactCard h2 {
57+
font-size: 1.08rem;
58+
margin: 0 0 0.5rem;
59+
}
60+
61+
.card p,
62+
.compactCard p {
63+
color: var(--ifm-color-emphasis-700);
64+
margin: 0;
65+
}
66+
67+
.eyebrow {
68+
color: var(--ifm-color-primary);
69+
font-size: 0.78rem;
70+
font-weight: 700;
71+
letter-spacing: 0;
72+
margin: 0 0 0.35rem;
73+
text-transform: uppercase;
74+
}
75+
76+
.section {
77+
border-top: 1px solid var(--ifm-color-emphasis-200);
78+
margin-top: 2rem;
79+
padding-top: 1.5rem;
80+
}
81+
82+
.linkList {
83+
display: grid;
84+
gap: 0.75rem;
85+
grid-template-columns: repeat(2, minmax(0, 1fr));
86+
}
87+
88+
.linkList a {
89+
border: 1px solid var(--ifm-color-emphasis-200);
90+
border-radius: 6px;
91+
display: block;
92+
font-weight: 600;
93+
padding: 0.85rem 1rem;
94+
text-decoration: none;
95+
}
96+
97+
.linkList a:hover {
98+
border-color: var(--ifm-color-primary);
99+
text-decoration: none;
100+
}
101+
102+
@media (max-width: 900px) {
103+
.wideGrid {
104+
grid-template-columns: repeat(2, minmax(0, 1fr));
105+
}
106+
}
107+
108+
@media (max-width: 720px) {
109+
.cardGrid,
110+
.wideGrid,
111+
.linkList {
112+
grid-template-columns: 1fr;
113+
}
114+
}

‎docs/category-pages/changelog.mdx‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Changelog
3+
slug: /category/changelog
4+
hide_table_of_contents: true
5+
---
6+
7+
import styles from './category-page.module.css';
8+
9+
# Changelog
10+
11+
<div className={styles.introPanel}>
12+
<p>Review FormKiQ release notes and changes by version.</p>
13+
</div>
14+
15+
<div className={styles.wideGrid}>
16+
<a className={styles.compactCard} href="/docs/changelog/v1.18.2"><h2>v1.18.2</h2><p>Latest documented release notes.</p></a>
17+
<a className={styles.compactCard} href="/docs/changelog/v1.18.1"><h2>v1.18.1</h2><p>Patch release notes.</p></a>
18+
<a className={styles.compactCard} href="/docs/changelog/v1.18.0"><h2>v1.18.0</h2><p>Release notes.</p></a>
19+
<a className={styles.compactCard} href="/docs/changelog/v1.17.1"><h2>v1.17.1</h2><p>Patch release notes.</p></a>
20+
<a className={styles.compactCard} href="/docs/changelog/v1.17.0"><h2>v1.17.0</h2><p>Release notes.</p></a>
21+
<a className={styles.compactCard} href="/docs/changelog/v1.16.1"><h2>v1.16.1</h2><p>Patch release notes.</p></a>
22+
<a className={styles.compactCard} href="/docs/changelog/v1.16.0"><h2>v1.16.0</h2><p>Release notes.</p></a>
23+
<a className={styles.compactCard} href="/docs/changelog/v1.15.1"><h2>v1.15.1</h2><p>Patch release notes.</p></a>
24+
<a className={styles.compactCard} href="/docs/changelog/v1.15.0"><h2>v1.15.0</h2><p>Release notes.</p></a>
25+
</div>
26+
27+
<div className={styles.section}>
28+
<h2>Older Versions</h2>
29+
<div className={styles.linkList}>
30+
<a href="/docs/changelog/v1.14.2">v1.14.2</a>
31+
<a href="/docs/changelog/v1.14.1">v1.14.1</a>
32+
<a href="/docs/changelog/v1.14.0">v1.14.0</a>
33+
<a href="/docs/changelog/v1.13.1">v1.13.1</a>
34+
<a href="/docs/changelog/v1.13.0">v1.13.0</a>
35+
</div>
36+
</div>

‎docs/category-pages/core-concepts-features.mdx‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Core Concepts & Features
3+
slug: /category/features
4+
hide_table_of_contents: true
5+
---
6+
7+
import styles from './category-page.module.css';
8+
9+
# Core Concepts & Features
10+
11+
<div className={styles.introPanel}>
12+
<p>Learn the main FormKiQ building blocks: documents, metadata, attributes, entities, OCR, search, workflows, rulesets, schemas, and localization.</p>
13+
</div>
14+
15+
<div className={styles.wideGrid}>
16+
<a className={styles.compactCard} href="/docs/features/documents"><h2>Documents</h2><p>Storage, metadata, actions, relationships, and document lifecycle behavior.</p></a>
17+
<a className={styles.compactCard} href="/docs/features/attributes"><h2>Attributes</h2><p>Structured metadata for filtering, classification, automation, and search.</p></a>
18+
<a className={styles.compactCard} href="/docs/features/search"><h2>Search</h2><p>Document retrieval through metadata, full text, and search integrations.</p></a>
19+
<a className={styles.compactCard} href="/docs/features/workflows"><h2>Workflows</h2><p>Route and process documents through operational workflows.</p></a>
20+
<a className={styles.compactCard} href="/docs/features/rulesets"><h2>Rulesets</h2><p>Apply conditional document automation and processing behavior.</p></a>
21+
<a className={styles.compactCard} href="/docs/features/ocr"><h2>OCR</h2><p>Extract text and support intelligent document processing flows.</p></a>
22+
<a className={styles.compactCard} href="/docs/features/schemas"><h2>Schemas</h2><p>Structure classification and site-level document metadata rules.</p></a>
23+
<a className={styles.compactCard} href="/docs/features/entities"><h2>Entities</h2><p>Model business objects that relate to documents and metadata.</p></a>
24+
<a className={styles.compactCard} href="/docs/features/mappings"><h2>Mappings</h2><p>Configure mappings for integrations and document metadata behavior.</p></a>
25+
<a className={styles.compactCard} href="/docs/features/locales"><h2>Locales</h2><p>Manage localized resource items and language-specific configuration.</p></a>
26+
</div>

‎docs/category-pages/how-to-guides.mdx‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: How-to Guides
3+
slug: /category/how-to
4+
hide_table_of_contents: true
5+
---
6+
7+
import styles from './category-page.module.css';
8+
9+
# How-to Guides
10+
11+
<div className={styles.introPanel}>
12+
<p>Use these task-focused guides when you need to complete a specific API or migration workflow.</p>
13+
</div>
14+
15+
<div className={styles.cardGrid}>
16+
<a className={styles.card} href="/docs/how-tos/api-add-documents">
17+
<p className={styles.eyebrow}>Documents</p>
18+
<h2>Add Documents</h2>
19+
<p>Add documents through the FormKiQ API.</p>
20+
</a>
21+
<a className={styles.card} href="/docs/how-tos/api-add-document-tags">
22+
<p className={styles.eyebrow}>Metadata</p>
23+
<h2>Add Document Tags</h2>
24+
<p>Attach tags and metadata to documents for organization and retrieval.</p>
25+
</a>
26+
<a className={styles.card} href="/docs/how-tos/api-document-search">
27+
<p className={styles.eyebrow}>Search</p>
28+
<h2>Search Documents</h2>
29+
<p>Search documents through API-driven query workflows.</p>
30+
</a>
31+
<a className={styles.card} href="/docs/how-tos/api-document-actions">
32+
<p className={styles.eyebrow}>Automation</p>
33+
<h2>Add Document Actions</h2>
34+
<p>Trigger and inspect document processing actions.</p>
35+
</a>
36+
<a className={styles.card} href="/docs/how-tos/jwt-authentication-token">
37+
<p className={styles.eyebrow}>Authentication</p>
38+
<h2>Get a JWT Authentication Token</h2>
39+
<p>Get a JWT token for API requests and Postman-based testing.</p>
40+
</a>
41+
<a className={styles.card} href="/docs/how-tos/manage-users-and-groups">
42+
<p className={styles.eyebrow}>Administration</p>
43+
<h2>Manage Users and Groups</h2>
44+
<p>Create users, assign groups, and set site permissions.</p>
45+
</a>
46+
<a className={styles.card} href="/docs/how-tos/manage-api-keys">
47+
<p className={styles.eyebrow}>Integration</p>
48+
<h2>Manage API Keys</h2>
49+
<p>Create, use, rotate, and revoke API keys for server-side integrations.</p>
50+
</a>
51+
<a className={styles.card} href="/docs/how-tos/folder-permissions-and-sharing">
52+
<p className={styles.eyebrow}>Access Control</p>
53+
<h2>Folder Permissions and Sharing</h2>
54+
<p>Create folders, assign permissions, and share folders with groups.</p>
55+
</a>
56+
<a className={styles.card} href="/docs/how-tos/document-versioning-checkout-legal-hold">
57+
<p className={styles.eyebrow}>Lifecycle</p>
58+
<h2>Versioning, Checkout, and Legal Hold</h2>
59+
<p>Inspect versions, restore a version, check out a document, and apply legal hold.</p>
60+
</a>
61+
<a className={styles.card} href="/docs/how-tos/webhooks-end-to-end">
62+
<p className={styles.eyebrow}>Automation</p>
63+
<h2>Webhooks End-to-End</h2>
64+
<p>Create and test webhook intake workflows.</p>
65+
</a>
66+
<a className={styles.card} href="/docs/how-tos/ocr-full-text-search-pipeline">
67+
<p className={styles.eyebrow}>Search</p>
68+
<h2>OCR and Full-Text Search Pipeline</h2>
69+
<p>Run OCR, inspect extracted text, add full-text content, and search it.</p>
70+
</a>
71+
<a className={styles.card} href="/docs/how-tos/audit-user-activity-reporting">
72+
<p className={styles.eyebrow}>Governance</p>
73+
<h2>Audit and User Activity Reporting</h2>
74+
<p>Retrieve document, user, and resource activity for audit workflows.</p>
75+
</a>
76+
<a className={styles.card} href="/docs/how-tos/migration-core-to-enterprise">
77+
<p className={styles.eyebrow}>Migration</p>
78+
<h2>Migrate Documents from Core to Enterprise</h2>
79+
<p>Migrate data between FormKiQ Core and Enterprise environments.</p>
80+
</a>
81+
</div>

‎docs/category-pages/modules-commercial-offerings.mdx‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Modules & Commercial Offerings
3+
slug: /category/formkiq-modules
4+
hide_table_of_contents: true
5+
---
6+
7+
import styles from './category-page.module.css';
8+
9+
# Modules & Commercial Offerings
10+
11+
<div className={styles.introPanel}>
12+
<p>Explore commercial deployment notes and optional modules for security, search, OCR, document generation, versioning, SSO, migration, and integrations.</p>
13+
</div>
14+
15+
<div className={styles.cardGrid}>
16+
<a className={styles.card} href="/docs/formkiq-modules/installation/formkiq">
17+
<p className={styles.eyebrow}>Commercial deployment</p>
18+
<h2>Deployment Notes</h2>
19+
<p>Understand customer-specific CloudFormation links and commercial deployment prerequisites.</p>
20+
</a>
21+
<a className={styles.card} href="/docs/formkiq-modules/installation/opensearch-serverless">
22+
<p className={styles.eyebrow}>Search</p>
23+
<h2>OpenSearch Serverless</h2>
24+
<p>Install and configure OpenSearch Serverless for enhanced document search.</p>
25+
</a>
26+
<a className={styles.card} href="/docs/formkiq-modules/modules/document-generation">
27+
<p className={styles.eyebrow}>Automation</p>
28+
<h2>Document Generation</h2>
29+
<p>Generate documents from templates and data as part of document workflows.</p>
30+
</a>
31+
<a className={styles.card} href="/docs/formkiq-modules/modules/filesync-cli">
32+
<p className={styles.eyebrow}>Migration</p>
33+
<h2>FileSync CLI</h2>
34+
<p>Use CLI tooling for document sync, import, and migration workflows.</p>
35+
</a>
36+
</div>
37+
38+
<div className={styles.section}>
39+
<h2>More Modules</h2>
40+
<div className={styles.linkList}>
41+
<a href="/docs/formkiq-modules/modules/document-versioning">Document Versioning</a>
42+
<a href="/docs/formkiq-modules/modules/enhanced-fulltext-document-search">Enhanced Full-Text Search</a>
43+
<a href="/docs/formkiq-modules/modules/enhanced-document-ocr-and-classification">Enhanced OCR and Classification</a>
44+
<a href="/docs/formkiq-modules/modules/anti-malware-antivirus">Anti-Malware / Antivirus</a>
45+
<a href="/docs/formkiq-modules/modules/full-encryption">Full Encryption</a>
46+
<a href="/docs/formkiq-modules/modules/single-sign-on-and-custom-jwt-authorizer">SSO and Custom JWT Authorizer</a>
47+
</div>
48+
</div>

‎docs/category-pages/operations.mdx‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Operations
3+
slug: /category/operations
4+
hide_table_of_contents: true
5+
---
6+
7+
import styles from './category-page.module.css';
8+
9+
# Operations
10+
11+
<div className={styles.introPanel}>
12+
<p>Operational guidance for maintaining FormKiQ environments, monitoring system health, managing backups, handling failures, and planning migrations.</p>
13+
</div>
14+
15+
<div className={styles.cardGrid}>
16+
<a className={styles.card} href="/docs/platform/updates_upgrades_and_rollbacks">
17+
<p className={styles.eyebrow}>Lifecycle</p>
18+
<h2>Updates, Upgrades, and Rollbacks</h2>
19+
<p>Plan and execute stack updates while preserving a rollback path.</p>
20+
</a>
21+
<a className={styles.card} href="/docs/platform/backup_and_recovery">
22+
<p className={styles.eyebrow}>Resilience</p>
23+
<h2>Backup and Recovery</h2>
24+
<p>Protect document data and platform configuration against failure scenarios.</p>
25+
</a>
26+
<a className={styles.card} href="/docs/platform/migration-and-data-import">
27+
<p className={styles.eyebrow}>Migration</p>
28+
<h2>Migration and Data Import</h2>
29+
<p>Plan document imports and migrations from existing systems.</p>
30+
</a>
31+
<a className={styles.card} href="/docs/how-tos/set-up-status-monitoring-and-alerting">
32+
<p className={styles.eyebrow}>Observability</p>
33+
<h2>Status Monitoring and Alerting</h2>
34+
<p>Set up monitoring and alerting for operational visibility.</p>
35+
</a>
36+
<a className={styles.card} href="/docs/platform/error_handling/dlq">
37+
<p className={styles.eyebrow}>Recovery</p>
38+
<h2>Dead-Letter Queue (DLQ)</h2>
39+
<p>Investigate failed asynchronous processing and safely redrive messages.</p>
40+
</a>
41+
</div>

‎docs/category-pages/platform-architecture.mdx‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Platform Architecture
3+
slug: /category/platform
4+
hide_table_of_contents: true
5+
---
6+
7+
import styles from './category-page.module.css';
8+
9+
# Platform Architecture
10+
11+
<div className={styles.introPanel}>
12+
<p>Understand how FormKiQ runs in your AWS account, how documents and metadata are stored, and how the platform is operated, extended, and sized.</p>
13+
</div>
14+
15+
<div className={styles.cardGrid}>
16+
<a className={styles.card} href="/docs/platform/overview">
17+
<p className={styles.eyebrow}>Start here</p>
18+
<h2>Platform Overview</h2>
19+
<p>Review the AWS-native architecture, core components, and design principles behind FormKiQ.</p>
20+
</a>
21+
<a className={styles.card} href="/docs/platform/document_storage">
22+
<p className={styles.eyebrow}>Storage</p>
23+
<h2>Document Storage</h2>
24+
<p>See how FormKiQ stores content, metadata, and related document data.</p>
25+
</a>
26+
<a className={styles.card} href="/docs/platform/document_console">
27+
<p className={styles.eyebrow}>User interface</p>
28+
<h2>Document Console</h2>
29+
<p>Configure and understand the web console used with FormKiQ deployments.</p>
30+
</a>
31+
<a className={styles.card} href="/docs/platform/costs">
32+
<p className={styles.eyebrow}>Planning</p>
33+
<h2>Costs</h2>
34+
<p>Review pricing and AWS cost considerations for planning a deployment.</p>
35+
</a>
36+
</div>
37+
38+
<div className={styles.section}>
39+
<h2>Deeper References</h2>
40+
<div className={styles.linkList}>
41+
<a href="/docs/platform/database_schema">Database Schema</a>
42+
<a href="/docs/platform/reporting-and-analytics">Reporting and Analytics</a>
43+
</div>
44+
</div>

0 commit comments

Comments
 (0)