Skip to content

Commit 8ee00de

Browse files
author
Faxbot Agent
committed
docs(links): replace docs.faxbot.net/latest with versioned 4ee1fb9 across repo (readme, security, sdks)
1 parent 7e84306 commit 8ee00de

File tree

9 files changed

+23
-23
lines changed

9 files changed

+23
-23
lines changed

.worktrees/gh-pages

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Subproject commit 24646c2e1adabd3f6af31a7f10244b5fdcec4434
1+
Subproject commit a01dc52e91550a02dfa2b6dd0f1083dbc6cfba95

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,22 +68,22 @@ The iOS companion lets you send faxes and check status from your phone. Email da
6868
## SDKs
6969
- Python: `pip install faxbot`
7070
- Node.js: `npm install faxbot`
71-
[SDK Usage](https://docs.faxbot.net/latest/sdks/)
71+
[SDK Usage](https://docs.faxbot.net/4ee1fb94/sdks/)
7272

7373
## Architecture highlights
7474
- Traits‑first capabilities: `/admin/providers` and `/admin/config` expose active providers + traits; UI and API gate features by traits.
7575
- Canonical event & error model: normalized inbound/outbound events, status mapping, and standard error codes.
7676
- Provider adapters: clean boundaries for verify_webhook/parse_inbound/send/status/cancel.
7777

7878
Docs:
79-
- [Canonical Events](https://docs.faxbot.net/latest/api/canonical-events/)
80-
- [MCP Integration](https://docs.faxbot.net/latest/mcp/)
81-
- [Reference Guide](https://docs.faxbot.net/latest/reference/)
79+
- [Canonical Events](https://docs.faxbot.net/4ee1fb94/api/canonical-events/)
80+
- [MCP Integration](https://docs.faxbot.net/4ee1fb94/mcp/)
81+
- [Reference Guide](https://docs.faxbot.net/4ee1fb94/reference/)
8282

8383
## Security
8484
- Use `X-API-Key` (multi‑key) for auth.
8585
- Enforce HTTPS and HMAC signature verification for cloud webhooks.
8686
- No PHI in logs; only IDs/metadata are surfaced.
8787

8888
## Contributing
89-
See [Contributing Guide](https://docs.faxbot.net/latest/getting-started/contributing/). Please open issues/PRs; this project is GUI‑first and traits‑first—avoid backend‑name checks in new code.
89+
See [Contributing Guide](https://docs.faxbot.net/4ee1fb94/getting-started/contributing/). Please open issues/PRs; this project is GUI‑first and traits‑first—avoid backend‑name checks in new code.

config/plugin_registry.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"categories": ["outbound"],
88
"capabilities": ["send", "get_status", "webhook"],
99
"description": "Recommended for most users; HIPAA-ready with BAA.",
10-
"learn_more": "https://docs.faxbot.net/latest/setup/phaxio/"
10+
"learn_more": "https://docs.faxbot.net/4ee1fb94/setup/phaxio/"
1111
},
1212
{
1313
"id": "signalwire",
@@ -16,7 +16,7 @@
1616
"categories": ["outbound"],
1717
"capabilities": ["send", "get_status", "webhook"],
1818
"description": "Cloud fax using Twilio‑style Compatibility API.",
19-
"learn_more": "https://docs.faxbot.net/latest/setup/signalwire/"
19+
"learn_more": "https://docs.faxbot.net/4ee1fb94/setup/signalwire/"
2020
},
2121
{
2222
"id": "freeswitch",
@@ -25,7 +25,7 @@
2525
"categories": ["outbound"],
2626
"capabilities": ["send"],
2727
"description": "Self‑hosted fax via mod_spandsp (txfax/rxfax).",
28-
"learn_more": "https://docs.faxbot.net/latest/setup/freeswitch/"
28+
"learn_more": "https://docs.faxbot.net/4ee1fb94/setup/freeswitch/"
2929
},
3030
{
3131
"id": "sinch",
@@ -34,7 +34,7 @@
3434
"categories": ["outbound"],
3535
"capabilities": ["send", "get_status"],
3636
"description": "Direct Sinch upload model for Phaxio by Sinch accounts.",
37-
"learn_more": "https://docs.faxbot.net/latest/setup/sinch/"
37+
"learn_more": "https://docs.faxbot.net/4ee1fb94/setup/sinch/"
3838
},
3939
{
4040
"id": "sip",
@@ -43,7 +43,7 @@
4343
"categories": ["outbound"],
4444
"capabilities": ["send", "get_status"],
4545
"description": "Advanced users; requires SIP trunk + T.38 and AMI.",
46-
"learn_more": "https://docs.faxbot.net/latest/setup/sip-asterisk/"
46+
"learn_more": "https://docs.faxbot.net/4ee1fb94/setup/sip-asterisk/"
4747
},
4848
{
4949
"id": "local",
@@ -52,7 +52,7 @@
5252
"categories": ["storage"],
5353
"capabilities": ["store", "retrieve", "delete"],
5454
"description": "Local storage for development only.",
55-
"learn_more": "https://docs.faxbot.net/latest/operations/"
55+
"learn_more": "https://docs.faxbot.net/4ee1fb94/operations/"
5656
},
5757
{
5858
"id": "s3",
@@ -61,7 +61,7 @@
6161
"categories": ["storage"],
6262
"capabilities": ["store", "retrieve", "delete"],
6363
"description": "Production storage with SSE-KMS recommended for PHI.",
64-
"learn_more": "https://docs.faxbot.net/latest/operations/"
64+
"learn_more": "https://docs.faxbot.net/4ee1fb94/operations/"
6565
}
6666
]
6767
}

docs/SDKS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ const client = new FaxbotClient('http://localhost:8080', 'YOUR_API_KEY');
6868
## MCP vs SDK
6969
- The SDKs do not include MCP (Model Context Protocol) logic. They are simple HTTP clients for developers.
7070
- MCP integration is a separate component (stdio/HTTP servers) for AI assistants.
71-
- See the guide: https://docs.faxbot.net/latest/mcp/ for setup, transports, and examples.
71+
- See the guide: https://docs.faxbot.net/4ee1fb94/mcp/ for setup, transports, and examples.

docs/SECURITY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Configuration and guidance for HIPAA‑aligned deployments and OAuth/OIDC setup.
2121
- WebSocket (Node): protect with `MCP_WS_API_KEY` (or `API_KEY`); run behind TLS or an authenticated proxy.
2222

2323
Recommended reading
24-
- [Authentication (API Keys)](https://docs.faxbot.net/latest/security/authentication/)
25-
- [HIPAA Requirements](https://docs.faxbot.net/latest/HIPAA_REQUIREMENTS/)
26-
- [OAuth/OIDC Setup](https://docs.faxbot.net/latest/security/oauth-setup/)
24+
- [Authentication (API Keys)](https://docs.faxbot.net/4ee1fb94/security/authentication/)
25+
- [HIPAA Requirements](https://docs.faxbot.net/4ee1fb94/HIPAA_REQUIREMENTS/)
26+
- [OAuth/OIDC Setup](https://docs.faxbot.net/4ee1fb94/security/oauth-setup/)
2727
- [Compliance Overview](https://faxbot.net/compliance/)
2828
- [Business Associate Agreement (PDF)](https://faxbot.net/compliance/business-associate-agreement.pdf)

docs/archive/legacy/SDKS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ const client = new FaxbotClient('http://localhost:8080', 'YOUR_API_KEY');
6868
## MCP vs SDK
6969
- The SDKs do not include MCP (Model Context Protocol) logic. They are simple HTTP clients for developers.
7070
- MCP integration is a separate component (stdio/HTTP servers) for AI assistants.
71-
- See the guide: https://docs.faxbot.net/latest/mcp/ for setup, transports, and examples.
71+
- See the guide: https://docs.faxbot.net/4ee1fb94/mcp/ for setup, transports, and examples.

docs/archive/legacy/SECURITY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Configuration and guidance for HIPAA‑aligned deployments and OAuth/OIDC setup.
2121
- WebSocket (Node): protect with `MCP_WS_API_KEY` (or `API_KEY`); run behind TLS or an authenticated proxy.
2222

2323
Recommended reading
24-
- [Authentication (API Keys)](https://docs.faxbot.net/latest/security/authentication/)
25-
- [HIPAA Requirements](https://docs.faxbot.net/latest/HIPAA_REQUIREMENTS/)
26-
- [OAuth/OIDC Setup](https://docs.faxbot.net/latest/security/oauth-setup/)
24+
- [Authentication (API Keys)](https://docs.faxbot.net/4ee1fb94/security/authentication/)
25+
- [HIPAA Requirements](https://docs.faxbot.net/4ee1fb94/HIPAA_REQUIREMENTS/)
26+
- [OAuth/OIDC Setup](https://docs.faxbot.net/4ee1fb94/security/oauth-setup/)
2727
- [Compliance Overview](https://faxbot.net/compliance/)
2828
- [Business Associate Agreement (PDF)](https://faxbot.net/compliance/business-associate-agreement.pdf)

sdks/node/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ run().catch(console.error);
4343

4444
## MCP Note
4545
- MCP (Model Context Protocol) is not part of this SDK. It is a separate integration layer for AI assistants.
46-
- Refer to the docs for setup and usage: https://docs.faxbot.net/latest/mcp/
46+
- Refer to the docs for setup and usage: https://docs.faxbot.net/4ee1fb94/mcp/

sdks/python/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ print("Status:", status["status"])
3939

4040
## MCP Note
4141
- MCP (Model Context Protocol) is not part of this SDK. It is a separate integration layer for AI assistants.
42-
- Refer to the docs for setup and usage: https://docs.faxbot.net/latest/mcp/
42+
- Refer to the docs for setup and usage: https://docs.faxbot.net/4ee1fb94/mcp/

0 commit comments

Comments
 (0)