add API

unimib-datAI · Jul 24, 2024 · 2c92386 · 2c92386
1 parent eb1d1f5
commit 2c92386
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 4 deletions.
diff --git a/docs/api/_category_.json b/docs/api/_category_.json
@@ -0,0 +1,7 @@
+{
+  "label": "API",
+  "position": 4,
+  "link": {
+    "type": "generated-index"
+  }
+}
diff --git a/docs/api/mantistable.config.js.md b/docs/api/mantistable.config.js.md
@@ -0,0 +1,6 @@
+---
+sidebar_position: 0
+description: API reference for Docusaurus configuration file.
+---
+
+# `mantistable.config.js`
diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md
@@ -1,3 +1,7 @@
 
 
-# Configuration
+# Configuration
+
+:::info
+
+Check the [**`mantistable.config.js` API reference**](/docs/api/mantistable.config.js) for an exhaustive list of options.
diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
@@ -1,3 +1 @@
-
-
 # Installation
diff --git a/docs/getting-started/running.md b/docs/getting-started/running.md
@@ -0,0 +1 @@
+# Running
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -2,4 +2,14 @@
 sidebar_position: 1
 ---
 
-# Introduction
+# Introduction
+
+Introducing **MantisTable UI**, the ultimate **web interface** for managing **Semantic Table Interpretation (STI)** approaches. Designing a user-friendly, robust UI from scratch can be an arduous endeavor, demanding a unique blend of technical prowess, design acumen, and meticulous attention to detail. MantisTable UI was developed to alleviate this burden, providing an intuitive, ready-to-use platform tailored for STI 🙀.
+
+MantisTable UI stands out with its **powerful and flexible plugin system**, enabling users to easily extend and customize its functionality. Whether you are a developer looking to integrate new features or a researcher aiming to adapt the tool to specific use cases, MantisTable UI offers a seamless experience 🦄, allowing for effortless expansion and personalization.
+
+With MantisTable UI, you can focus on what truly matters—advancing your work in semantic table interpretation—while enjoying the benefits of a sophisticated, user-centric interface designed to enhance productivity and streamline your workflow 💅. Say goodbye to the complexities of UI development and embrace the efficiency and versatility of MantisTable UI.
+
+This manual is designed to comprehensively walk through every aspect of setting up and using MantisTable UI, including every interface function and feature.
+
+This user manual starts with instructions for [installing or upgrading MantisTable UI on Windows, Mac, and Linux computers](getting-started/installation.md). It then walks you through [the interface and how to run MantisTable UI](getting-started/running.md) from a command line, with or without setting custom [preferences and modifications](getting-started/configuration.md).