diff --git a/docs/docs/API-docs/intro.md b/docs/docs/API-docs/intro.md new file mode 100644 index 000000000..dc5ed4a4a --- /dev/null +++ b/docs/docs/API-docs/intro.md @@ -0,0 +1,26 @@ +# Overview + +OpenSign™ API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures. + +# Key Features + +- **Document Creation**: Allows for the generation of digital documents directly through the API. +- **Template Creation**: Supports the creation and management of document templates for consistent use across various applications. +- **Electronic Signature Integration**: Provides capabilities for incorporating electronic signatures into documents. +- **User Management**: Facilitates the management of user accounts, permissions, and roles within an application. +- **Contacts Management**: Enables efficient handling of contact information and integration with document processes. +- **Compliance and Security**: Ensures all operations adhere to global legal standards for electronic signatures and data security. +- **Customization and Flexibility**: Offers highly customizable workflows, tailored to meet diverse organizational requirements. +- **Cross-Platform Compatibility**: Assures seamless functionality across various platforms and devices. + +# Target Audience + +- **Developers and IT Professionals**: Implementing digital document management and electronic signature solutions. +- **Businesses and Enterprises**: Seeking efficient and secure digital document workflows. +- **Legal and Compliance Teams**: Requiring digital solutions compliant with legal standards for signatures and document management. + +# Usage Scenarios + +- Streamlining contract creation and signing processes in corporate environments. +- Managing user permissions and contacts for large-scale document workflows. +- Utilizing templates for standardized document processes in legal, financial, and governmental sectors. diff --git a/docs/docs/help/New-Document/request-signatures.md b/docs/docs/help/New-Document/request-signatures.md new file mode 100644 index 000000000..acedbeaf7 --- /dev/null +++ b/docs/docs/help/New-Document/request-signatures.md @@ -0,0 +1,57 @@ +--- +sidebar_position: 2 +title: Request signatures +--- + +# OpenSign™ Request signatures Interface + +## Interface Overview + +The OpenSign™ Request signatures interface is designed to streamline the process of creating, preparing, and sending documents for electronic signature. + + +# How to Create and Send a Document for Signature with OpenSign™ + +### Step 1: Begin New Document Creation + +- **[1] New Document**: Start by clicking the 'New Document' header to initiate the creation of a document for signature. + +### Step 2: Uploading Your Document + +- **[2] Choose File**: Click here to select and upload the document file from your computer that needs to be signed. + +### Step 3: Entering Document Details + +- **[4] Title** *(Required)*: Input the title of your document. This identifier will be visible to signers and in your document management. +- **[5] Description**: Optionally add a description to give context or instructions regarding the document. + +### Step 4: Adding Signers + +- **[6] Signers**: Use the dropdown and addition button to add the email addresses of the people who need to sign the document. + +### Step 5: Providing Additional Information + +- **[7] Note**: Input any notes or special instructions for the signers here. + +### Step 6: Organizing Your Document + +- **[8] Folder**: Choose the 'Root' folder or select another folder where the signed document will be stored. + +### Step 7: Setting the Time Frame + +- **[9] Time To Complete (Days)** *(Required)*: Specify the number of days the signers have to complete the signatures. + +### Step 8: Finalizing the Document Submission + +- **[6] SUBMIT**: Once all the necessary fields are filled, click this button to send the document out for signing. +- **[6] RESET**: If you need to start over or make changes, click this button to clear the form. + +## Additional Information + +- All fields marked with an asterisk (*) must be completed before the document can be submitted. +- Ensure that the document format is supported by OpenSign before uploading. +- Signed documents can be accessed in the designated 'Root' folder or the one you have specified. + +For further assistance, contact our customer support team. + +Experience the ease of document signing with OpenSign! \ No newline at end of file diff --git a/docs/docs/help/New-Document/sign-yourself.md b/docs/docs/help/New-Document/sign-yourself.md index 63a2f0a13..75da39a06 100644 --- a/docs/docs/help/New-Document/sign-yourself.md +++ b/docs/docs/help/New-Document/sign-yourself.md @@ -1,8 +1,9 @@ --- sidebar_position: 1 +title: Sign yourself --- -# Sign yourself +# OpenSign™ Sign yourself interface This lets you sign documents that dont need to be sent to anybody. diff --git a/docs/docs/help/intro.md b/docs/docs/help/intro.md index d4ffb410d..0de1d2230 100644 --- a/docs/docs/help/intro.md +++ b/docs/docs/help/intro.md @@ -8,6 +8,8 @@ Let's discover **OpenSign** in detail. This section will walk you through each a ## Getting Started -Get started by deploying a new instance of **OpenSign**. +**try OpenSign on cloud** at **[OpenSignLabs](https://app.opensignlabs.com)**. -Or **try OpenSign on cloud** at **[OpenSignLabs](https://app.opensignlabs.com)**. +Or + +Get started by deploying a new instance of **OpenSign**. \ No newline at end of file diff --git a/docs/docs/help/tutorial-basics/_category_.json b/docs/docs/help/tutorial-basics/_category_.json deleted file mode 100644 index 2e6db55b1..000000000 --- a/docs/docs/help/tutorial-basics/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Tutorial - Basics", - "position": 2, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/docs/help/tutorial-basics/congratulations.md b/docs/docs/help/tutorial-basics/congratulations.md deleted file mode 100644 index 04771a00b..000000000 --- a/docs/docs/help/tutorial-basics/congratulations.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/) -- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) -- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/docs/docs/help/tutorial-basics/create-a-blog-post.md b/docs/docs/help/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index ea472bbaf..000000000 --- a/docs/docs/help/tutorial-basics/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/docs/docs/help/tutorial-basics/create-a-document.md b/docs/docs/help/tutorial-basics/create-a-document.md deleted file mode 100644 index c22fe2944..000000000 --- a/docs/docs/help/tutorial-basics/create-a-document.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -export default { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/docs/docs/help/tutorial-basics/deploy-your-site.md b/docs/docs/help/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 1c50ee063..000000000 --- a/docs/docs/help/tutorial-basics/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/docs/docs/help/tutorial-basics/markdown-features.mdx b/docs/docs/help/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 53197243f..000000000 --- a/docs/docs/help/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to Create a page. -``` - -```md -Let's see how to Create a page. -``` - -**Result:** Let's see how to Create a page. - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - -```md - -``` - - - -You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: - -```md - -``` - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - - ```jsx title="src/components/HelloDocusaurus.js" - function HelloDocusaurus() { - return ( -