chore: docs into categories

rooka-ai · Dec 11, 2024 · 882aa2b · 882aa2b
1 parent e51ba44
commit 882aa2b
Show file tree

Hide file tree

Showing 16 changed files with 237 additions and 242 deletions.
diff --git a/pairlegal-documentation/README.md b/pairlegal-documentation/README.md
@@ -5,21 +5,21 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
 ### Installation
 
 ```
-$ yarn
+yarn
 ```
 
 ### Local Development
 
 ```
-$ yarn start
+yarn start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
 ### Build
 
 ```
-$ yarn build
+yarn build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
@@ -29,13 +29,13 @@ This command generates static content into the `build` directory and can be serv
 Using SSH:
 
 ```
-$ USE_SSH=true yarn deploy
+USE_SSH=true yarn deploy
 ```
 
 Not using SSH:
 
 ```
-$ GIT_USER=<Your GitHub username> yarn deploy
+GIT_USER=<Your GitHub username> yarn deploy
 ```
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/pairlegal-documentation/docs/AI.md → pairlegal-documentation/docs/Features/AI.md b/pairlegal-documentation/docs/AI.md → pairlegal-documentation/docs/Features/AI.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 8
----
-
 # AI
 
 We offer options to customize the AI according to your needs. You can choose your
@@ -63,11 +59,3 @@ addition to the opening screen, also displayed in a separate thread in the Chat
 When selecting text in a file, AI can be used to suggest different variations of the
 text, taking into account the context of the file.
 See Editing tab for more information.
-
-## Adaptive replace
-
-:::warning Coming soon
-:::
-Swap pairs of terms (e.g., "Company" –> "Buyers") over a document in a
-contextually-aware way. After selecting the pair or pairs, the plugin returns a list of
-suggested replacements, which can be individually accepted or rejected.
diff --git a/pairlegal-documentation/docs/alerts.md → ...gal-documentation/docs/Features/alerts.md b/pairlegal-documentation/docs/alerts.md → ...gal-documentation/docs/Features/alerts.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 6
----
-
 # Alerts
 
 ## Overview

diff --git a/...cumentation/docs/definition-extraction.md → ...on/docs/Features/definition-extraction.md b/...cumentation/docs/definition-extraction.md → ...on/docs/Features/definition-extraction.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 5
----
-
 # Definition tracking
 
 ## Overview

diff --git a/pairlegal-documentation/docs/editing.md → ...al-documentation/docs/Features/editing.md b/pairlegal-documentation/docs/editing.md → ...al-documentation/docs/Features/editing.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 9
----
-
 # Editing
 
 Select a clause in the document and choose from a variety of editing options.

diff --git a/...ocumentation/docs/external_information.md → ...ion/docs/Features/external_information.md b/...ocumentation/docs/external_information.md → ...ion/docs/Features/external_information.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 7
----
-
 # External information
 
 The external information feature enriches your legal documents by automatically

diff --git a/pairlegal-documentation/docs/administrators.mdx b/pairlegal-documentation/docs/administrators.mdx
diff --git a/pairlegal-documentation/docs/authentication.md b/pairlegal-documentation/docs/authentication.md
diff --git a/pairlegal-documentation/docs/getting_started.md b/pairlegal-documentation/docs/getting_started.md
@@ -1,21 +1,30 @@
 ---
 sidebar_position: 1
 ---
-# Getting started
 
-Thank you for your interest in SingleDraft, the AI legal writing assistant
-integrated into MS Word. Our solution provides a layer of insights over a contract
-opened in MS Word:
+# Welcome to SingleDraft
 
-- connecting information within the document (such as defined terms),
-- connecting with external information (such as information from Company House),
-- and providing suggestions on model clauses based on the internal database.
+SingleDraft is an AI-enhanced legal writing assistant that integrates with Microsoft
+Word, designed to complement your expertise in legal drafting. Rather than disrupting
+your established workflow, SingleDraft provides intelligent insights right where you
+work.
 
-SingleDraft is **built with respect for your craft**, leaving you in control of the
-document at all times and providing you with the insights you need to make the best
-decisions.
+## Where to Begin
 
-## Install
+1. **Installation**: Get started by installing SingleDraft on your Windows or Mac device.
+Visit our installation guide for step-by-step
+instructions.
 
-The plugin is available for both Windows and Mac platforms. For installation steps
-follow this [link](../installation).
+2. **Features**: Learn about SingleDraft's capabilities in our features overview, where
+we explain how each individual feature can enhance your drafting process.
+
+## Support
+
+Our customer support team is here to help you make the most of SingleDraft. Whether you
+have questions about features, need technical assistance, or want to provide feedback:
+
+- Reach out to us via Intercom, either here or in the SingleDraft app
+- Book a [consultation call](https://cal.com/rooka/15min) with our team
+
+We are committed to supporting your legal drafting needs and welcome your questions and
+feedback.
diff --git a/pairlegal-documentation/docs/installation/index.mdx b/pairlegal-documentation/docs/installation/index.mdx
diff --git a/...entation/docs/installation/install365.mdx → ...l_information/Installation/install365.mdx b/...entation/docs/installation/install365.mdx → ...l_information/Installation/install365.mdx
@@ -1,13 +1,13 @@
 import Image from "@theme/IdealImage";
-import moreaddins from "../../static/img/installation_steps/moreaddins.png";
-import home from "../../static/img/installation_steps/home.png";
-import step6 from "../../static/img/installation_steps/step6.png";
-import step5 from "../../static/img/installation_steps/step5.png";
-import step4 from "../../static/img/installation_steps/step4.png";
-import step3 from "../../static/img/installation_steps/step3.png";
-import step2 from "../../static/img/installation_steps/step2.png";
-import step1 from "../../static/img/installation_steps/step1.png";
-import refresh from "../../static/img/installation_steps/refresh.png";
+import moreaddins from "../../../static/img/installation_steps/moreaddins.png";
+import home from "../../../static/img/installation_steps/home.png";
+import step6 from "../../../static/img/installation_steps/step6.png";
+import step5 from "../../../static/img/installation_steps/step5.png";
+import step4 from "../../../static/img/installation_steps/step4.png";
+import step3 from "../../../static/img/installation_steps/step3.png";
+import step2 from "../../../static/img/installation_steps/step2.png";
+import step1 from "../../../static/img/installation_steps/step1.png";
+import refresh from "../../../static/img/installation_steps/refresh.png";
 
 # Installation with Office 365
 
@@ -61,10 +61,12 @@ This page follows the official
   - Click Finish deployment
 
 - **Go to Home tab in MS Word and click on Add-ins**
-:::tip Sign in to MS Word
-Make sure to be signed in the MS Word with the account that is among the approved
-accounts that were assigned in previous step.
-:::
+  :::tip Sign in to MS Word
+  Make sure to be signed in the MS Word with the account that is among the approved
+  accounts that were assigned in previous step.
+  :::
+
+  {" "}
 
   <Image img={home} />