WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-13 13:17:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: update docs

Browse Source
This commit is contained in:
nxglabs
2023-12-27 02:19:58 +05:30
parent 62541f1450
commit 861f822151
16 changed files with 90 additions and 457 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/API-docs/intro.md
+26
View File
@@ -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.
docs/docs/help/New-Document/request-signatures.md
+57
View File
@@ -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!
docs/docs/help/New-Document/sign-yourself.md
+2 -1
View File
@@ -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.
docs/docs/help/intro.md
+4 -2
View File
@@ -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**.
docs/docs/help/tutorial-basics/_category_.json
-8
View File
@@ -1,8 +0,0 @@
{
"label": "Tutorial - Basics",
"position": 2,
"link": {
"type": "generated-index",
"description": "5 minutes to learn the most important Docusaurus concepts."
}
}
docs/docs/help/tutorial-basics/congratulations.md
-23
View File
@@ -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)
docs/docs/help/tutorial-basics/create-a-blog-post.md
-34
View File
@@ -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).
docs/docs/help/tutorial-basics/create-a-document.md
-57
View File
@@ -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'],
},
],
};
```
docs/docs/help/tutorial-basics/deploy-your-site.md
-31
View File
@@ -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)**).
docs/docs/help/tutorial-basics/markdown-features.mdx
-150
View File
@@ -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
![Docusaurus logo](/img/docusaurus.png)
```
![Docusaurus logo](/img/docusaurus.png)
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
![Docusaurus logo](./img/docusaurus.png)
```
## Code Blocks
Markdown code blocks are supported with Syntax highlighting.
```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
return (
<h1>Hello, Docusaurus!</h1>
)
}
```
```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
return <h1>Hello, Docusaurus!</h1>;
}
```
## Admonitions
Docusaurus has a special syntax to create admonitions and callouts:
:::tip My tip
Use this awesome feature option
:::
:::danger Take care
This action is dangerous
:::
:::tip My tip
Use this awesome feature option
:::
:::danger Take care
This action is dangerous
:::
## MDX and React Components
[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
```jsx
export const Highlight = ({children, color}) => (
<span
style={{
backgroundColor: color,
borderRadius: '20px',
color: '#fff',
padding: '10px',
cursor: 'pointer',
}}
onClick={() => {
alert(`You clicked the color ${color} with label ${children}`)
}}>
{children}
</span>
);
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
```
export const Highlight = ({children, color}) => (
<span
style={{
backgroundColor: color,
borderRadius: '20px',
color: '#fff',
padding: '10px',
cursor: 'pointer',
}}
onClick={() => {
alert(`You clicked the color ${color} with label ${children}`);
}}>
{children}
</span>
);
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
docs/docs/help/tutorial-extras/_category_.json
-7
View File
@@ -1,7 +0,0 @@
{
"label": "Tutorial - Extras",
"position": 3,
"link": {
"type": "generated-index"
}
}
docs/docs/help/tutorial-extras/img/docsVersionDropdown.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 25 KiB

docs/docs/help/tutorial-extras/img/localeDropdown.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 27 KiB

docs/docs/help/tutorial-extras/manage-docs-versions.md
-55
View File
@@ -1,55 +0,0 @@
---
sidebar_position: 1
---
# Manage Docs Versions
Docusaurus can manage multiple versions of your docs.
## Create a docs version
Release a version 1.0 of your project:
```bash
npm run docusaurus docs:version 1.0
```
The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created.
Your docs now have 2 versions:
- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs
- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
## Add a Version Dropdown
To navigate seamlessly across versions, add a version dropdown.
Modify the `docusaurus.config.js` file:
```js title="docusaurus.config.js"
export default {
themeConfig: {
navbar: {
items: [
// highlight-start
{
type: 'docsVersionDropdown',
},
// highlight-end
],
},
},
};
```
The docs version dropdown appears in your navbar:
![Docs Version Dropdown](./img/docsVersionDropdown.png)
## Update an existing version
It is possible to edit versioned docs in their respective folder:
- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`
docs/docs/help/tutorial-extras/translate-your-site.md
-88
View File
@@ -1,88 +0,0 @@
---
sidebar_position: 2
---
# Translate your site
Let's translate `docs/intro.md` to French.
## Configure i18n
Modify `docusaurus.config.js` to add support for the `fr` locale:
```js title="docusaurus.config.js"
export default {
i18n: {
defaultLocale: 'en',
locales: ['en', 'fr'],
},
};
```
## Translate a doc
Copy the `docs/intro.md` file to the `i18n/fr` folder:
```bash
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
```
Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
## Start your localized site
Start your site on the French locale:
```bash
npm run start -- --locale fr
```
Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated.
:::caution
In development, you can only use one locale at a time.
:::
## Add a Locale Dropdown
To navigate seamlessly across languages, add a locale dropdown.
Modify the `docusaurus.config.js` file:
```js title="docusaurus.config.js"
export default {
themeConfig: {
navbar: {
items: [
// highlight-start
{
type: 'localeDropdown',
},
// highlight-end
],
},
},
};
```
The locale dropdown now appears in your navbar:
![Locale Dropdown](./img/localeDropdown.png)
## Build your localized site
Build your site for a specific locale:
```bash
npm run build -- --locale fr
```
Or build your site to include all the locales at once:
```bash
npm run build
```
docs/src/pages/index.js
+1 -1
View File
@@ -16,7 +16,7 @@ function HomepageHeader() {
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/intro">
to="/docs/help/intro">
Access Docs 🚀
</Link>
</div>