diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 418473b..6541d07 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -1,8 +1,11 @@ import { defineConfig } from "vitepress"; export default defineConfig({ - title: "Certifaction", - description: "Privacy-first eSigning", + title: "Developer Portal | Certifaction Digital PAdES Signature with Privacy", + titleTemplate: ":title - Certifaction Digital PAdES Signature with Privacy", + description: + "Integrate Certifaction PAdES digital signature of highly confidential documents in your application and service.", + cleanUrls: true, lastUpdated: true, @@ -17,21 +20,24 @@ export default defineConfig({ themeConfig: { siteTitle: false, logo: { - "light": "/certifaction_logo.svg", - "dark": "/certifaction_logo_white.svg", + light: "/certifaction_logo.svg", + dark: "/certifaction_logo_white.svg", }, socialLinks: [ - { icon: "github", link: "https://github.com/certifaction/cli" }, - { icon: "linkedin", link: "https://www.linkedin.com/company/certifaction-ag/" }, + { icon: "github", link: "https://github.com/certifaction/cli" }, + { + icon: "linkedin", + link: "https://www.linkedin.com/company/certifaction-ag/", + }, ], editLink: { - pattern: "https://github.com/certifaction/cli/edit/main/docs/:path", - text: "Edit this page on GitHub", + pattern: "https://github.com/certifaction/cli/edit/main/docs/:path", + text: "Edit this page on GitHub", }, footer: { - copyright: "Copyright © 2020-present Certifaction AG", + copyright: "Copyright © 2020-present Certifaction AG", }, nav: [ { diff --git a/docs/guides/digital-signature.md b/docs/guides/digital-signature.md index c931d55..5a0e280 100644 --- a/docs/guides/digital-signature.md +++ b/docs/guides/digital-signature.md @@ -1,4 +1,9 @@ -# Digital signature +--- +title: Certifaction PAdES Digital Signature +description: Details of Certifaction PAdES digital signature for highly confidential documents +--- + +# Digital Signature Certifaction's digital signature allows users to add one or more digital signatures to PDF documents. diff --git a/docs/guides/digital-twin.md b/docs/guides/digital-twin.md index f7c789c..9d615e3 100644 --- a/docs/guides/digital-twin.md +++ b/docs/guides/digital-twin.md @@ -1,3 +1,8 @@ +--- +title: Certifaction Digital Twin +description: Use Certifaction E2E encryption QR code to share and sign highly confidential documents +--- + # Certifaction Digital Twin You can secure your printed documents with a [Digital Twin](https://certifaction.com/digital-twin/). diff --git a/docs/guides/getting-started-api.md b/docs/guides/getting-started-api.md index 76b223d..99f9ed9 100644 --- a/docs/guides/getting-started-api.md +++ b/docs/guides/getting-started-api.md @@ -1,5 +1,6 @@ --- -title: Getting Started with the Local API +title: Getting Started with Certifaction Local API +description: How to use Certifaction Client to digitally sign highly confidential documents --- # Getting Started with the Local API diff --git a/docs/guides/getting-started-cli.md b/docs/guides/getting-started-cli.md index 00e9686..8f16203 100644 --- a/docs/guides/getting-started-cli.md +++ b/docs/guides/getting-started-cli.md @@ -1,5 +1,6 @@ --- -title: Getting Started with the CLI +title: Getting Started with Certifaction CLI +description: How to use Certifaction command line interface to igitally sign highly confidential documents --- # Getting Started with the CLI diff --git a/docs/guides/howto-check-document-status.md b/docs/guides/howto-check-document-status.md index 416008a..790bbb2 100644 --- a/docs/guides/howto-check-document-status.md +++ b/docs/guides/howto-check-document-status.md @@ -1,8 +1,9 @@ --- -title: Check document status +title: Check Document Status +description: How to check the status of Certifaction digital signature of highly confidential documents --- -# Check document status +# Check Document Status To check the status of a document, use the [`/request/list`](../references/api#post-/request/list) endpoint. diff --git a/docs/guides/howto-download-documents.md b/docs/guides/howto-download-documents.md index 24bccaa..471cad7 100644 --- a/docs/guides/howto-download-documents.md +++ b/docs/guides/howto-download-documents.md @@ -1,8 +1,9 @@ --- -title: Download documents +title: Download Documents +description: How to download highly confidential documents digitally signed with Certifaction --- -# Download documents +# Download Documents To download documents, use the [`/download`](../references/api#get-/download) endpoint. diff --git a/docs/guides/howto-request-multiple-signatures.md b/docs/guides/howto-request-multiple-signatures.md index 8c5c184..f4ad33d 100644 --- a/docs/guides/howto-request-multiple-signatures.md +++ b/docs/guides/howto-request-multiple-signatures.md @@ -1,8 +1,9 @@ --- -title: Request multiple signatures +title: Request Multiple Signatures +description: How to request several digital signatures of highly confidential documents using Certifaction --- -# Request multiple signatures +# Request Multiple Signatures If one document needs to be signed by multiple signers, you need to prepare the document first or download the document after you have created the first signature request and diff --git a/docs/guides/howto-request-one-signature.md b/docs/guides/howto-request-one-signature.md index 3fbf769..c491543 100644 --- a/docs/guides/howto-request-one-signature.md +++ b/docs/guides/howto-request-one-signature.md @@ -1,8 +1,9 @@ --- title: Request one signature +description: How to request the digital signature of a highly confidential document using Certifaction --- -# Request one signature +# Request a Signature If want someone else to sign a document, you can use the [`/request/create`](../references/api#post-/request/create) endpoint. You can also use a document that was already signed by you and use it as the input for a signature request. diff --git a/docs/guides/howto-sign-documents.md b/docs/guides/howto-sign-documents.md index 8ba3ebe..661d333 100644 --- a/docs/guides/howto-sign-documents.md +++ b/docs/guides/howto-sign-documents.md @@ -1,8 +1,9 @@ --- -title: Sign documents +title: Sign Documents +description: How to digitally sign confidential documents with Certifaction --- -# Sign documents +# Sign Documents To sign a document, you can use the [`/sign`](../references/api#post-/sign) endpoint. The document will be signed in the name of the owner of the API key. To add another signature, an already signed document diff --git a/docs/guides/installation.md b/docs/guides/installation.md index effc46a..1b519ea 100644 --- a/docs/guides/installation.md +++ b/docs/guides/installation.md @@ -1,3 +1,8 @@ +--- +title: How to install Certifaction Client +description: How to install the Certifaction Client to digitally sign highly confidential documents +--- + # Installation Use the Certifaction Client to integrate with Certifaction. diff --git a/docs/guides/local-processing.md b/docs/guides/local-processing.md index e22f930..bdb5107 100644 --- a/docs/guides/local-processing.md +++ b/docs/guides/local-processing.md @@ -1,3 +1,8 @@ +--- +title: Certifaction Local Processing +description: Certifaction client local processing and E2E encryption protects your highly confidential documents +--- + # Local Processing Local document processing ensures document confidentiality. diff --git a/docs/guides/security.md b/docs/guides/security.md index c1471a1..0cfe75d 100644 --- a/docs/guides/security.md +++ b/docs/guides/security.md @@ -1,3 +1,8 @@ +--- +title: Certifaction Security and Privacy +description: Certifaction digital signature security and privacy features protects highly confidential documents +--- + # Security and Privacy One of our main pillars is the Security and Privacy of our customers information. This section highlights some of the specific security measures that we have taken to achieve this objective. diff --git a/docs/guides/signature-request.md b/docs/guides/signature-request.md index e86bd4f..178d394 100644 --- a/docs/guides/signature-request.md +++ b/docs/guides/signature-request.md @@ -1,4 +1,9 @@ -# Signature request +--- +title: Signature Request +description: Use Certifaction to request digital signature for highly confidential documents +--- + +# Signature Request Users can invite other people to sign documents by providing them with secure signature request URLs, which contain a secret key. The secret key will decrypt the document before signing, ensuring that no third-party (not even Certifaction) has access to the document in clear text. diff --git a/docs/guides/what-is-certifaction.md b/docs/guides/what-is-certifaction.md index 95dccb2..07fa7b7 100644 --- a/docs/guides/what-is-certifaction.md +++ b/docs/guides/what-is-certifaction.md @@ -1,5 +1,6 @@ --- title: What is Certifaction? +description: Certifaction the solution to digitally sigh highly confidential documents --- # What is Certifaction? diff --git a/docs/references/api.md b/docs/references/api.md index 40eff7d..a4128dd 100644 --- a/docs/references/api.md +++ b/docs/references/api.md @@ -1,5 +1,6 @@ --- -title: Local API +title: Certifaction Local API +description: Certifaction Client API uses local processing and E2E encryption to digitally sign highly confidential documents. aside: false --- diff --git a/docs/references/authentication.md b/docs/references/authentication.md index 5968601..6bd1295 100644 --- a/docs/references/authentication.md +++ b/docs/references/authentication.md @@ -1,3 +1,8 @@ +--- +title: Authentication +description: How to authenticate to Certifaction to digitally sign highly confidential documents. +--- + # Authentication Document signature, revocation and getting user information require authentication. diff --git a/docs/references/cli.md b/docs/references/cli.md index 430b3a2..38159f4 100644 --- a/docs/references/cli.md +++ b/docs/references/cli.md @@ -1,3 +1,8 @@ +--- +title: Certifaction CLI Reference +description: Certifaction Client command line interface uses local processing and E2E encryption to digitally sign highly confidential documents. +--- + # CLI Reference [[toc]] diff --git a/docs/references/http-proxy-settings.md b/docs/references/http-proxy-settings.md index 6acf0b1..720a510 100644 --- a/docs/references/http-proxy-settings.md +++ b/docs/references/http-proxy-settings.md @@ -1,4 +1,9 @@ -# HTTP Proxy settings +--- +title: HTTP Proxy Settings +description: Certifaction Client API uses local processing and E2E encryption to digitally sign highly confidential documents. +--- + +# HTTP Proxy Settings Certifaction client integrates with Certifaction API using HTTPS. If the deployment is behind a proxy you must configure the