Skip to content

Conversation

Manny-r31
Copy link
Contributor

Documentation Update Pull Request

Description

Recreated and restructured fax first steps guide. Renamed fax-1,2,3.webp files and moved to correct locations. Added images utilizing new dashboard for main guide.

Related Issue

Resolves #526

Type of Change

  • [x ] Update to existing documentation

Documentation Change Details

  • Made extensive changes to fax first steps guide for an easier first time user experience
  • Added images to reference new dashboard for use in this guide as well as others.
  • Renamed old fax images on page and moved to images folder with the hybrid prefix.

Motivation and Context

This change is required as multiple users have experienced issues not being able to follow the guide due to it not providing steps for the new dashboard:

Example 1
Example 2

Checklist:

  • My documentation follows the style guidelines of this project
  • I have performed a self-review of my documentation
  • My changes generate no new warnings
  • Builds successfully locally

…ebp files and moved to correct locations. Added images utilizing new dashboard for main guide.
@netlify
Copy link

netlify bot commented Sep 23, 2025

Deploy Preview for signalwire-docs ready!

Name Link
🔨 Latest commit 17c6b65
🔍 Latest deploy log https://app.netlify.com/projects/signalwire-docs/deploys/68f635662257060008f75727
😎 Deploy Preview https://deploy-preview-542--signalwire-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 26 (🔴 down 2 from production)
Accessibility: 91 (no change from production)
Best Practices: 92 (no change from production)
SEO: 89 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@Manny-r31 Manny-r31 changed the title Fax first steps guide refresh WIP - Fax first steps guide refresh Sep 24, 2025
…ved formatting inconsistencies and updated cxml script example image.
@Manny-r31 Manny-r31 marked this pull request as draft September 25, 2025 20:08
@Manny-r31 Manny-r31 changed the title WIP - Fax first steps guide refresh Fax first steps guide refresh Sep 25, 2025
@Manny-r31 Manny-r31 marked this pull request as ready for review October 6, 2025 19:23
@Manny-r31 Manny-r31 marked this pull request as draft October 7, 2025 20:33
@Manny-r31 Manny-r31 marked this pull request as ready for review October 15, 2025 12:31
- product:fax
---

import Subtitle from "@site/src/components/typography/Subtitle";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to import the Subtitle component or anything else in website/src/theme/MDXComponents/index.js

Suggested change
import Subtitle from "@site/src/components/typography/Subtitle";

</TabItem>
</Tabs>

:::info [Alternative: Using webhooks or SDKs]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove square brackets

Suggested change
:::info [Alternative: Using webhooks or SDKs]
:::info Alternative: Using webhooks or SDKs


<Steps>

#### Obtain a phone number
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Convert these headers to H3s rather than H4s, so they show up in the TOC.

Suggested change
#### Obtain a phone number
### Obtain a phone number

[Log in](https://signalwire.com/signin) to your SignalWire Space.
If you don't have a number yet, navigate to the Phone Numbers section and [buy a new phone number](/platform/phone-numbers/getting-started/buying-a-phone-number).

#### Create a SWML script
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Convert these headers to H3s rather than H4s, so they show up in the TOC.

Suggested change
#### Create a SWML script
### Create a SWML script

Save the script; it should now be located in your Resources tab on the left sidebar under Scripts.
#### Configure phone number for SWML
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Convert these headers to H3s rather than H4s, so they show up in the TOC.

Suggested change
#### Configure phone number for SWML
### Configure phone number for SWML


Save the script; it should now be located in your Resources tab on the left sidebar under Scripts.

#### Configure phone number for cXML
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Convert these headers to H3s rather than H4s, so they show up in the TOC.

Suggested change
#### Configure phone number for cXML
### Configure phone number for cXML


Select the newly created cXML script, then click "Save" to apply the configuration.

#### Test your setup
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Convert these headers to H3s rather than H4s, so they show up in the TOC.

Suggested change
#### Test your setup
### Test your setup

Comment on lines +188 to +192
### Create a cXML Script

Navigate to the "LaML/cXML" section of your Dashboard and create a new cXML bin.

### Assign a phone number
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Subjective, but I would make these H4s to keep them out of the TOC

Suggested change
### Create a cXML Script
Navigate to the "LaML/cXML" section of your Dashboard and create a new cXML bin.
### Assign a phone number
#### Create a cXML Script
Navigate to the "LaML/cXML" section of your Dashboard and create a new cXML bin.
#### Assign a phone number

- receive_fax: {}
```
Save the script; it should now be located in your Resources tab on the left sidebar under Scripts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bold references to UI elements

Suggested change
Save the script; it should now be located in your Resources tab on the left sidebar under Scripts.
Save the script. It should now be located in your **Resources** tab on the left sidebar, under **Scripts**.

<Tabs groupId="rest-api-method">
<TabItem value="url" label="Webhook url">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize

Suggested change
<TabItem value="url" label="Webhook url">
<TabItem value="url" label="Webhook URL">

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fax Doc steps update for new UI

3 participants