Merge pull request #18 from OnedocLabs/fileforge-rename

rename FF to Ff
OnedocLabs · Jun 5, 2024 · 31a0ea4 · 31a0ea4
2 parents 37efa21 + b996095
commit 31a0ea4
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 29 deletions.
diff --git a/fern/pages/help_center/html_to_pdf/generate-hosted-pdf-from-html.mdx b/fern/pages/help_center/html_to_pdf/generate-hosted-pdf-from-html.mdx
@@ -1,4 +1,4 @@
-This documentation provides an example of how to use the FileForgeClient to generate a hosted PDF file from HTML.
+This documentation provides an example of how to use the FileforgeClient to generate a hosted PDF file from HTML.
 
 #### Prerequisites
 

diff --git a/fern/pages/help_center/html_to_pdf/generate-pdf-from-html-assets.mdx b/fern/pages/help_center/html_to_pdf/generate-pdf-from-html-assets.mdx
@@ -1,4 +1,4 @@
-This documentation provides an example of how to use the FileForgeClient to generate a PDF file from HTML with CSS, and SVG files aside.
+This documentation provides an example of how to use the FileforgeClient to generate a PDF file from HTML with CSS, and SVG files aside.
 
 #### Prerequisites
 
@@ -22,7 +22,7 @@ const HTML_W_IMAGE = `<!DOCTYPE html>
     </head>
     <body>
         <h1>Hello World!</h1>
-        <img src="logo-black.svg" alt="FileForge logo" />
+        <img src="logo-black.svg" alt="Fileforge logo" />
     </body>
 </html>
 `

diff --git a/fern/pages/help_center/html_to_pdf/generate-pdf-from-html-react-print.mdx b/fern/pages/help_center/html_to_pdf/generate-pdf-from-html-react-print.mdx
@@ -1,4 +1,4 @@
-This documentation provides an example of how to use the FileForgeClient to generate a hosted PDF file from HTML.
+This documentation provides an example of how to use the FileforgeClient to generate a hosted PDF file from HTML.
 
 #### Prerequisites
 

diff --git a/fern/pages/overview/introduction.mdx b/fern/pages/overview/introduction.mdx
@@ -1,17 +1,17 @@
 ---
-title: Welcome to FileForge
+title: Welcome to Fileforge
 ---
 
-Welcome to FileForge's API documentation! 👋 
-<br/><br/>**FileForge is an API for PDF document workflows.**
-<br/>FileForge enables developers to perform any PDF task like generation, form filling, digital signature and more. 
+Welcome to Fileforge's API documentation! 👋 
+<br/><br/>**Fileforge is an API for PDF document workflows.**
+<br/>Fileforge enables developers to perform any PDF task like generation, form filling, digital signature and more. 
 Our open-source library helps developers build complex documents that integrate with our API and external services to build document-centric workflows. 
-<br/>Here you’ll find resources and guides for the FileForge API and open-source React library for PDF generation: [react-print](/react-print/welcome/). 
+<br/>Here you’ll find resources and guides for the Fileforge API and open-source React library for PDF generation: [react-print](/react-print/welcome/). 
 <br/>Please don’t hesitate to contact us at [email protected] if you need assisance.
 
 ### Official API Clients
 
-FileForge maintains official API clients for Python, Node/Typescript, and Go. We recommend using these clients to interact
+Fileforge maintains official API clients for Python, Node/Typescript, and Go. We recommend using these clients to interact
 with all stable endpoints. You can find them here:
 
 <Cards>

diff --git a/fern/pages/react-print/introduction.mdx b/fern/pages/react-print/introduction.mdx
@@ -1,8 +1,8 @@
 ---
-title: Welcome to react-print-pdf by FileForge
+title: Welcome to react-print-pdf by Fileforge
 ---
 
-Welcome to FileForge's API documentation! Here you'll find information about the various endpoints available to you,
+Welcome to Fileforge's API documentation! Here you'll find information about the various endpoints available to you,
 as well as the parameters and responses that they accept and return. If you have any questions, feel free to reach out on Discord.
 
 ### Official API Clients

diff --git a/fern/pages/sdk-reference/node/PDF/fromDocx.mdx b/fern/pages/sdk-reference/node/PDF/fromDocx.mdx
@@ -66,7 +66,7 @@ const ff = new FileforgeClient({
 
 #### Notes
 
-- To enable variable replacement as Word variables for your account, please contact the FileForge support.
+- To enable variable replacement as Word variables for your account, please contact the Fileforge support.
 - Variable replacement is supported with various methods:
      * Templated litterals: `{{name}}`
      * Word variables, as listed in the document metadata: `{DOCVARIABLE "name"}`
diff --git a/fern/pages/sdk-reference/node/PDF/generate.mdx b/fern/pages/sdk-reference/node/PDF/generate.mdx
@@ -28,9 +28,9 @@ public async generate<Options extends Fileforge.PdfGenerateRequest>(
 | Option      | Type    | Default               | Constraints                                      | Description                                                                                                                                                                 |
 |-------------|---------|-----------------------|--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `test`      | boolean | `true`                |                                                  | Determines whether to generate a test document instead of a production document. Test documents include a watermark to indicate their status.                              |
-| `host`      | boolean | `false`               |                                                  | Enables hosting of the generated PDF document by FileForge. When set to `true`, FileForge manages the document storage and provides a presigned URL for access.             |
+| `host`      | boolean | `false`               |                                                  | Enables hosting of the generated PDF document by Fileforge. When set to `true`, Fileforge manages the document storage and provides a presigned URL for access.             |
 | `expiresAt` | Date    | 7 days from generation| The expiration date cannot exceed 7 days from the generation date. | Specifies the expiration date of the presigned URL when the `host` option is enabled. This controls how long the document will be accessible via the presigned URL before it expires. |
-| `fileName`  | string  | `"document"`          | The file name should not include file extensions or path traversal characters such as `/` or `\\`. | Sets the name of the generated PDF file. This name is used when saving the file and in any hosted URLs provided by FileForge. It allows for easier identification of documents but must be handled carefully to avoid file system conflicts. |
+| `fileName`  | string  | `"document"`          | The file name should not include file extensions or path traversal characters such as `/` or `\\`. | Sets the name of the generated PDF file. This name is used when saving the file and in any hosted URLs provided by Fileforge. It allows for easier identification of documents but must be handled carefully to avoid file system conflicts. |
 
 - `requestOptions` (optional): Additional options for the request, such as timeout settings and retry behavior.
 

diff --git a/fern/pages/sdk-reference/node/errors.mdx b/fern/pages/sdk-reference/node/errors.mdx
@@ -1,16 +1,16 @@
-### Error Handling in FileForge Functions
+### Error Handling in Fileforge Functions
 
 #### Overview
 
-Error handling is a crucial aspect of any application that interacts with external APIs. The FileForge functions, are designed to throw specific errors based on different failure scenarios. Proper error handling ensures that your application can gracefully handle issues and provide meaningful feedback to users.
+Error handling is a crucial aspect of any application that interacts with external APIs. The Fileforge functions, are designed to throw specific errors based on different failure scenarios. Proper error handling ensures that your application can gracefully handle issues and provide meaningful feedback to users.
 
 #### Common Errors
 
-The FileForge functions can throw the following common errors:
+The Fileforge functions can throw the following common errors:
 
-- `FileForge.BadRequestError`
-- `FileForge.UnauthorizedError`
-- `FileForge.InternalServerError`
-- `FileForge.BadGatewayError`
-- `FileForgeTimeoutError`
-- `FileForgeError`
+- `Fileforge.BadRequestError`
+- `Fileforge.UnauthorizedError`
+- `Fileforge.InternalServerError`
+- `Fileforge.BadGatewayError`
+- `FileforgeTimeoutError`
+- `FileforgeError`
diff --git a/fern/pages/sdk-reference/node/introduction.mdx b/fern/pages/sdk-reference/node/introduction.mdx
@@ -1,6 +1,6 @@
 ## Introduction
 
-The `FileforgeClient` is a powerful SDK for interacting with the FileForge API. It provides methods to generate and merge PDF documents from various web assets. This client handles communication with the FileForge service, making it easy to integrate into your projects.
+The `FileforgeClient` is a powerful SDK for interacting with the Fileforge API. It provides methods to generate and merge PDF documents from various web assets. This client handles communication with the Fileforge service, making it easy to integrate into your projects.
 
 ## Installation
 

diff --git a/openapi.yml b/openapi.yml
@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
-  title: FileForge API
-  description: FileForge API for document operations.
+  title: Fileforge API
+  description: Fileforge API for document operations.
   version: 0.1.0
 components:
   securitySchemes:
@@ -86,7 +86,7 @@ paths:
 
 
         To enable variable replacement as Word variables for your account,
-        please contact the FileForge support.
+        please contact the Fileforge support.
       requestBody:
         content:
           multipart/form-data:
@@ -216,7 +216,7 @@ paths:
                       default: true
                     host:
                       type: boolean
-                      description: If enabled, the document will be hosted by FileForge and a
+                      description: If enabled, the document will be hosted by Fileforge and a
                         presigned URL will be returned.
                       default: false
                     expiresAt: