Skip to content

Commit 4eef316

Browse files
mfriesenmfriesen
committed
Organize how-to guides by workflow category
1 parent e45d073 commit 4eef316

2 files changed

Lines changed: 130 additions & 80 deletions

File tree

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

Lines changed: 92 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -12,70 +12,96 @@ import styles from './category-page.module.css';
1212
<p>Use these task-focused guides when you need to complete a specific API or migration workflow.</p>
1313
</div>
1414

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>
15+
<div className={styles.section}>
16+
<h2>Authentication & Access</h2>
17+
<div className={styles.cardGrid}>
18+
<a className={styles.card} href="/docs/how-tos/jwt-authentication-token">
19+
<p className={styles.eyebrow}>Authentication</p>
20+
<h2>Get a JWT Authentication Token</h2>
21+
<p>Get a JWT token for API requests and Postman-based testing.</p>
22+
</a>
23+
<a className={styles.card} href="/docs/how-tos/manage-api-keys">
24+
<p className={styles.eyebrow}>Integration</p>
25+
<h2>Manage API Keys</h2>
26+
<p>Create, use, rotate, and revoke API keys for server-side integrations.</p>
27+
</a>
28+
<a className={styles.card} href="/docs/how-tos/manage-users-and-groups">
29+
<p className={styles.eyebrow}>Administration</p>
30+
<h2>Manage Users and Groups</h2>
31+
<p>Create users, assign groups, and set site permissions.</p>
32+
</a>
33+
<a className={styles.card} href="/docs/how-tos/folder-permissions-and-sharing">
34+
<p className={styles.eyebrow}>Access Control</p>
35+
<h2>Folder Permissions and Sharing</h2>
36+
<p>Create folders, assign permissions, and share folders with groups.</p>
37+
</a>
38+
</div>
39+
</div>
40+
41+
<div className={styles.section}>
42+
<h2>Documents & Metadata</h2>
43+
<div className={styles.cardGrid}>
44+
<a className={styles.card} href="/docs/how-tos/api-add-documents">
45+
<p className={styles.eyebrow}>Documents</p>
46+
<h2>Add Documents</h2>
47+
<p>Add documents through the FormKiQ API.</p>
48+
</a>
49+
<a className={styles.card} href="/docs/how-tos/api-add-document-tags">
50+
<p className={styles.eyebrow}>Metadata</p>
51+
<h2>Add Document Tags</h2>
52+
<p>Attach tags and metadata to documents for organization and retrieval.</p>
53+
</a>
54+
<a className={styles.card} href="/docs/how-tos/api-document-search">
55+
<p className={styles.eyebrow}>Search</p>
56+
<h2>Search Documents</h2>
57+
<p>Search documents through API-driven query workflows.</p>
58+
</a>
59+
<a className={styles.card} href="/docs/how-tos/document-versioning-checkout-legal-hold">
60+
<p className={styles.eyebrow}>Lifecycle</p>
61+
<h2>Versioning, Checkout, and Legal Hold</h2>
62+
<p>Inspect versions, restore a version, check out a document, and apply legal hold.</p>
63+
</a>
64+
</div>
65+
</div>
66+
67+
<div className={styles.section}>
68+
<h2>Automation & Processing</h2>
69+
<div className={styles.cardGrid}>
70+
<a className={styles.card} href="/docs/how-tos/api-document-actions">
71+
<p className={styles.eyebrow}>Automation</p>
72+
<h2>Add Document Actions</h2>
73+
<p>Trigger and inspect document processing actions.</p>
74+
</a>
75+
<a className={styles.card} href="/docs/how-tos/webhooks-end-to-end">
76+
<p className={styles.eyebrow}>Automation</p>
77+
<h2>Webhooks End-to-End</h2>
78+
<p>Create and test webhook intake workflows.</p>
79+
</a>
80+
<a className={styles.card} href="/docs/how-tos/ocr-full-text-search-pipeline">
81+
<p className={styles.eyebrow}>Search</p>
82+
<h2>OCR and Full-Text Search Pipeline</h2>
83+
<p>Run OCR, inspect extracted text, add full-text content, and search it.</p>
84+
</a>
85+
</div>
86+
</div>
87+
88+
<div className={styles.section}>
89+
<h2>Operations, Audit & Migration</h2>
90+
<div className={styles.cardGrid}>
91+
<a className={styles.card} href="/docs/how-tos/audit-user-activity-reporting">
92+
<p className={styles.eyebrow}>Governance</p>
93+
<h2>Audit and User Activity Reporting</h2>
94+
<p>Retrieve document, user, and resource activity for audit workflows.</p>
95+
</a>
96+
<a className={styles.card} href="/docs/how-tos/set-up-status-monitoring-and-alerting">
97+
<p className={styles.eyebrow}>Operations</p>
98+
<h2>Status Monitoring and Alerting</h2>
99+
<p>Set up availability checks, AWS service metrics, failed processing alerts, and alert routing.</p>
100+
</a>
101+
<a className={styles.card} href="/docs/how-tos/migration-core-to-enterprise">
102+
<p className={styles.eyebrow}>Migration</p>
103+
<h2>Migrate Documents from Core to Enterprise</h2>
104+
<p>Migrate data between FormKiQ Core and Enterprise environments.</p>
105+
</a>
106+
</div>
81107
</div>

‎sidebars.js‎

Lines changed: 38 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -277,19 +277,44 @@ const sidebars = {
277277
id: "category-pages/how-to-guides",
278278
},
279279
items: [
280-
"how-tos/api-add-documents",
281-
"how-tos/api-add-document-tags",
282-
"how-tos/api-document-search",
283-
"how-tos/api-document-actions",
284-
"how-tos/jwt-authentication-token",
285-
"how-tos/manage-users-and-groups",
286-
"how-tos/manage-api-keys",
287-
"how-tos/folder-permissions-and-sharing",
288-
"how-tos/document-versioning-checkout-legal-hold",
289-
"how-tos/webhooks-end-to-end",
290-
"how-tos/ocr-full-text-search-pipeline",
291-
"how-tos/audit-user-activity-reporting",
292-
"how-tos/migration-core-to-enterprise",
280+
{
281+
type: "category",
282+
label: "Authentication & Access",
283+
items: [
284+
"how-tos/jwt-authentication-token",
285+
"how-tos/manage-api-keys",
286+
"how-tos/manage-users-and-groups",
287+
"how-tos/folder-permissions-and-sharing",
288+
],
289+
},
290+
{
291+
type: "category",
292+
label: "Documents & Metadata",
293+
items: [
294+
"how-tos/api-add-documents",
295+
"how-tos/api-add-document-tags",
296+
"how-tos/api-document-search",
297+
"how-tos/document-versioning-checkout-legal-hold",
298+
],
299+
},
300+
{
301+
type: "category",
302+
label: "Automation & Processing",
303+
items: [
304+
"how-tos/api-document-actions",
305+
"how-tos/webhooks-end-to-end",
306+
"how-tos/ocr-full-text-search-pipeline",
307+
],
308+
},
309+
{
310+
type: "category",
311+
label: "Operations, Audit & Migration",
312+
items: [
313+
"how-tos/audit-user-activity-reporting",
314+
"how-tos/set-up-status-monitoring-and-alerting",
315+
"how-tos/migration-core-to-enterprise",
316+
],
317+
},
293318
],
294319
},
295320
{
@@ -303,7 +328,6 @@ const sidebars = {
303328
"platform/updates_upgrades_and_rollbacks",
304329
"platform/backup_and_recovery",
305330
"platform/migration-and-data-import",
306-
"how-tos/set-up-status-monitoring-and-alerting",
307331
"platform/error_handling/dlq",
308332
],
309333
},

0 commit comments

Comments
 (0)