Skip to content

Commit 2b82eb0

Browse files
author
Faxbot Agent
committed
docs(mkdocs/material): iconified quick links, search hint, and HIPAA tasklists with icons
1 parent 0865de2 commit 2b82eb0

File tree

12 files changed

+19
-19
lines changed

12 files changed

+19
-19
lines changed

mkdocs/docs/admin-console/setup-wizard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Setup Wizard
77
Configure Faxbot end‑to‑end from a guided flow: outbound provider, optional inbound, storage, and security.
88

99
!!! tip "Quick links"
10-
[Settings](/admin-console/settings/){ .md-button } [Diagnostics](/admin-console/diagnostics/){ .md-button } [Plugin Builder](/admin-console/plugin-builder/){ .md-button .md-button--primary }
10+
[:material-cog: Settings](/admin-console/settings/){ .md-button } [:material-stethoscope: Diagnostics](/admin-console/diagnostics/){ .md-button } [:material-puzzle: Plugin Builder](/admin-console/plugin-builder/){ .md-button .md-button--primary }
1111

1212
=== "Evaluate (Quick Tunnel)"
1313

mkdocs/docs/apps/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ Companion apps for using Faxbot beyond the browser.
1313
The iOS app is part of the commercial offering. These docs cover usage and pairing only.
1414

1515
!!! tip "Quick links"
16-
[iOS](/apps/ios/){ .md-button } [Desktop](/apps/electron/){ .md-button .md-button--primary }
16+
[:material-apple-ios: iOS](/apps/ios/){ .md-button } [:material-desktop-mac: Desktop](/apps/electron/){ .md-button .md-button--primary }

mkdocs/docs/getting-started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Getting Started
77
Launch Faxbot locally, send your first fax, and explore the Admin Console.
88

99
!!! tip "Quick links"
10-
[Setup Wizard](/admin-console/setup-wizard/){ .md-button } [Go‑Live](/go-live/){ .md-button } [Webhooks](/setup/webhooks/){ .md-button .md-button--primary }
10+
[:material-cog: Setup Wizard](/admin-console/setup-wizard/){ .md-button } [:material-rocket-launch: Go‑Live](/go-live/){ .md-button } [:material-webhook: Webhooks](/setup/webhooks/){ .md-button .md-button--primary }
1111

1212
## Quick start
1313

mkdocs/docs/go-live/documo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Documo (mFax) Go‑Live Checklist
77
Documo’s mFax API is a cloud backend with direct upload. PUBLIC_API_URL is not required for outbound, but is recommended for Admin links.
88

99
!!! tip "Quick links"
10-
[Documo API Docs](https://docs.documo.com){ .md-button } [mFax Pricing](https://www.mfax.io/pricing){ .md-button } [Setup Wizard](/admin-console/setup-wizard/){ .md-button .md-button--primary }
10+
[:material-book-open-variant: API Docs](https://docs.documo.com){ .md-button } [:material-currency-usd: mFax Pricing](https://www.mfax.io/pricing){ .md-button } [:material-cog: Setup Wizard](/admin-console/setup-wizard/){ .md-button .md-button--primary }
1111

1212
## Pre‑flight
1313

mkdocs/docs/go-live/humblefax.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: HumbleFax Go‑Live Checklist
77
HumbleFax is a lightweight cloud provider supported for outbound sending and inbound delivery via webhooks. It also offers a native email‑to‑fax flow you can use alongside Faxbot.
88

99
!!! tip "Quick links"
10-
[How it works](https://humblefax.com/?jump=how-it-works){ .md-button } [Sign up](https://humblefax.com/signup){ .md-button } [Setup Wizard](/admin-console/setup-wizard/){ .md-button .md-button--primary }
10+
[:material-help-circle: How it works](https://humblefax.com/?jump=how-it-works){ .md-button } [:material-account-plus: Sign up](https://humblefax.com/signup){ .md-button } [:material-cog: Setup Wizard](/admin-console/setup-wizard/){ .md-button .md-button--primary }
1111

1212
## Pre‑flight
1313

mkdocs/docs/go-live/phaxio-onepager.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ curl -sS -X POST "$PUBLIC_API_URL/fax" \
3232

3333
## HIPAA checklist
3434

35-
- [ ] BAA executed with provider
36-
- [ ] Provider document retention disabled
37-
- [ ] HTTPS enforced end‑to‑end; strong TLS
38-
- [ ] No PHI in logs; keys masked
39-
- [ ] Keys rotated; least‑privilege access
35+
- [ ] :material-file-sign: BAA executed with provider
36+
- [ ] :material-database-off: Provider document retention disabled
37+
- [ ] :material-lock-check: HTTPS enforced end‑to‑end; strong TLS
38+
- [ ] :material-eye-off: No PHI in logs; keys masked
39+
- [ ] :material-key-change: Keys rotated; least‑privilege access
4040

4141
## Help
4242

mkdocs/docs/go-live/sinch-onepager.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ curl -sS -X POST "$PUBLIC_API_URL/fax" \
3030

3131
## HIPAA checklist
3232

33-
- [ ] Prefer OAuth (`SINCH_AUTH_METHOD=oauth`)
34-
- [ ] HTTPS enforced; strong TLS
35-
- [ ] No PHI in logs; keys masked
36-
- [ ] Keys rotated; least‑privilege access
33+
- [ ] :material-shield-key: Prefer OAuth (`SINCH_AUTH_METHOD=oauth`)
34+
- [ ] :material-lock-check: HTTPS enforced; strong TLS
35+
- [ ] :material-eye-off: No PHI in logs; keys masked
36+
- [ ] :material-key-change: Keys rotated; least‑privilege access
3737

3838
!!! warning "HIPAA"
3939
Prefer OAuth, enforce HTTPS, and review [HIPAA Requirements](/HIPAA_REQUIREMENTS/).

mkdocs/docs/networking/tunnels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Networking & Tunnels
77
Options to reach your Faxbot API from outside your LAN. Use a quick tunnel for demos, and a HIPAA‑capable tunnel for production.
88

99
!!! tip "Quick links"
10-
[Setup Wizard](/admin-console/setup-wizard/){ .md-button } [Diagnostics](/admin-console/diagnostics/){ .md-button } [Webhooks](/setup/webhooks/){ .md-button .md-button--primary }
10+
[:material-cog: Setup Wizard](/admin-console/setup-wizard/){ .md-button } [:material-stethoscope: Diagnostics](/admin-console/diagnostics/){ .md-button } [:material-webhook: Webhooks](/setup/webhooks/){ .md-button .md-button--primary }
1111

1212
## Options
1313

mkdocs/docs/setup/phaxio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Phaxio Setup
77
Cloud backend where Phaxio fetches your PDF via a tokenized URL and posts status callbacks.
88

99
!!! tip "Quick links"
10-
[Webhooks](https://www.phaxio.com/docs/api/v2.1/intro/webhooks){ .md-button } [Verify Callbacks](https://www.phaxio.com/docs/security/callbacks){ .md-button } [Diagnostics](/admin-console/diagnostics/){ .md-button .md-button--primary }
10+
[:material-webhook: Webhooks](https://www.phaxio.com/docs/api/v2.1/intro/webhooks){ .md-button } [:material-shield-check: Verify Callbacks](https://www.phaxio.com/docs/security/callbacks){ .md-button } [:material-stethoscope: Diagnostics](/admin-console/diagnostics/){ .md-button .md-button--primary }
1111

1212
## Steps
1313

mkdocs/docs/setup/signalwire.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: SignalWire Setup (Compatibility API)
77
Outbound fax via SignalWire’s Compatibility (Twilio‑style) API. Inbound delivery is supported via the Plugin Manager (manifest providers), so you can enable full inbound flows when you install or upload a SignalWire inbound plugin.
88

99
!!! tip "Quick links"
10-
[SignalWire Fax](https://developer.signalwire.com/fax){ .md-button } [Compatibility API](https://developer.signalwire.com/compatibility-api){ .md-button } [Plugin Builder](/admin-console/plugin-builder/){ .md-button .md-button--primary }
10+
[:material-fax: SignalWire Fax](https://developer.signalwire.com/fax){ .md-button } [:material-code-json: Compatibility API](https://developer.signalwire.com/compatibility-api){ .md-button } [:material-puzzle: Plugin Builder](/admin-console/plugin-builder/){ .md-button .md-button--primary }
1111

1212
## Steps
1313

0 commit comments

Comments
 (0)