Current state
- Source file:
/signalwire-fern-config/fern/products/platform/pages/calling/fax/common-fax-errors.mdx
- Live URL:
https://signalwire.com/docs/platform/fax/common-errors
- Page type (Fern): reference
What's there today
- Introductory paragraph with guidance to contact support and include Fax SID ("Per our carrier peers' requirements, these SIDs MUST be from the last 24 hours.")
- 16 error codes, each with Meaning, Reason, and Troubleshooting Steps as bold labels followed by body text
- Errors cover connection issues, transmission problems, modem negotiation failures, and protocol incompatibilities (e.g., "Connection Failed," "Document generation error," "Unexpected DCN while waiting for DCS DIS")
- Completely text-based; no visual components, tables, accordions, or structured UI elements
Reviewer's concern
Incorrect styling, requires full rewrite.
Problems
- No catalog components: Page relies entirely on plain text with bold labels.
- Flat hierarchy: All errors are H3 with bolded inline labels; no semantic structure separates "meaning," "reason," and "steps" visually or via MDX components
- Missing tip: "Per our carrier peers’ requirements, these SIDs MUST be from the last 24 hours." should be inside of a
- Poor readability for quick lookup: Developers scanning for a specific error code have to parse dense text blocks; an accordion, table, or even a param field would allow them to more easily find what they need
Proposed rewrite
- Intro section: Wrap the opening guidance on SID viability and support assistance in a
<Warning> component
- Errors as either a table, Paramfield, or inside of some form of component.
- Still having issues?: New section that links to support.signalwire.com for users to submit a ticket.
Current state
/signalwire-fern-config/fern/products/platform/pages/calling/fax/common-fax-errors.mdxhttps://signalwire.com/docs/platform/fax/common-errorsWhat's there today
Reviewer's concern
Problems
Proposed rewrite
<Warning>component