From af97906fa5164e42abd44f5cd181fda629e88996 Mon Sep 17 00:00:00 2001
From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com.>
Date: Thu, 19 Dec 2024 22:37:28 +0000
Subject: [PATCH] move docs around change get started
---
About.md | 21 -------------------
Contact.md | 21 -------------------
Demo.md | 21 -------------------
docs/{Overview => }/Getting Started.md | 28 +++++++++++++++++++-------
docs/Overview/What is Stirling-PDF.md | 28 --------------------------
docs/Overview/_category_.json | 3 ---
6 files changed, 21 insertions(+), 101 deletions(-)
delete mode 100644 About.md
delete mode 100644 Contact.md
delete mode 100644 Demo.md
rename docs/{Overview => }/Getting Started.md (63%)
delete mode 100644 docs/Overview/What is Stirling-PDF.md
delete mode 100644 docs/Overview/_category_.json
diff --git a/About.md b/About.md
deleted file mode 100644
index 428e8d7..0000000
--- a/About.md
+++ /dev/null
@@ -1,21 +0,0 @@
-import React from 'react';
-import Layout from '@theme/Layout';
-
-export default function about() {
- return (
-
-
-
- );
-}
\ No newline at end of file
diff --git a/Contact.md b/Contact.md
deleted file mode 100644
index 42ab0d3..0000000
--- a/Contact.md
+++ /dev/null
@@ -1,21 +0,0 @@
-import React from 'react';
-import Layout from '@theme/Layout';
-
-export default function contact() {
- return (
-
-
-
- );
-}
\ No newline at end of file
diff --git a/Demo.md b/Demo.md
deleted file mode 100644
index 54e9998..0000000
--- a/Demo.md
+++ /dev/null
@@ -1,21 +0,0 @@
-import React from 'react';
-import Layout from '@theme/Layout';
-
-export default function demo() {
- return (
-
-
-
- );
-}
\ No newline at end of file
diff --git a/docs/Overview/Getting Started.md b/docs/Getting Started.md
similarity index 63%
rename from docs/Overview/Getting Started.md
rename to docs/Getting Started.md
index d605845..3791095 100644
--- a/docs/Overview/Getting Started.md
+++ b/docs/Getting Started.md
@@ -1,9 +1,24 @@
---
-sidebar_position: 1
+sidebar_position: 0
+slug: /
---
-# Getting Started with Stirling PDF
-Welcome to Stirling PDF! This guide will help you choose the right installation method based on your needs.
+## Benefits of Stirling-PDF
+- **Extensive PDF Functionality:** Access 50+ tools, including signing, converting, merging, and more.
+- **Advanced Customization:** Deep customization, themes, and environment variables.
+- **Enterprise Features:** SSO, user management, and permission controls.
+- **Data Security:** Local file processing with automatic deletion post-task.
+- **Scalability & Automation:** Batch processing with Docker and Kubernetes support.
+- **API Integration:** Use APIs for automation and external integrations.
+- **Open-Source:** Community-driven with frequent updates and GitHub support.
+- **Multi-Language Support:** Available in 38+ languages with active translations.
+
+Please feel free to request new features or report bugs through our [GitHub](https://github.com/Stirling-Tools/Stirling-PDF/issues) or [Discord](https://discord.gg/Cn8pWhQRxZ).
+
+
+## Introduction
+
+This guide will help you choose the right installation method based on your needs.
We prioritise and focus on our Server deployment options however we also offer a [Ultra-Lite model](/Installation/Versions) for desktop users
## Choose Your Installation Type
@@ -14,7 +29,6 @@ If you want to run Stirling PDF on your personal computer:
1. **Windows Users**
- Download our installer ([Stirling-PDF-win-installer.exe](https://github.com/Stirling-Tools/Stirling-PDF/releases/latest/download/Stirling-PDF-win-installer.exe)) for a simple, standalone experience
- Refer to our [Windows Installation Guide](/Installation/Windows%20Installation) for detailed setup instructions
- - Note: A UI installer version is coming in the next release!
2. **Linux/Unix Users**
- Dedicated Linux installer to be released soon, Currently you must run Stirling-PDF as a java jar
@@ -37,15 +51,15 @@ If you're looking to host Stirling PDF as a service:
2. **Manual Server Setup**
- For bare metal server installations
- - Use Stirling-PDF-Server package
+ - Use Stirling-PDF.jar package
- Follow our [Unix Installation Guide](/Installation/Unix%20Installation) for setup steps
## Quick Reference Table
| Installation Type | Best For | Documentation Link |
|------------------|----------|-------------------|
-| Stirling-PDF.exe | Windows desktop users | [Windows Guide](/Installation/Windows%20Installation) |
-| Stirling-PDF-Server | Server deployments without Docker | [Unix Guide](/Installation/Unix%20Installation) |
+| Stirling-PDF-installer.exe | Windows desktop users | [Windows Guide](/Installation/Windows%20Installation) |
+| Stirling-PDF.jar | Server deployments without Docker | [Unix Guide](/Installation/Unix%20Installation) |
| Docker Images | Server deployments with Docker | [Docker Guide](/Installation/Docker%20Install) |
Choose the installation method that best suits your needs and environment. Each guide provides detailed instructions for getting Stirling PDF up and running on your system.
diff --git a/docs/Overview/What is Stirling-PDF.md b/docs/Overview/What is Stirling-PDF.md
deleted file mode 100644
index f59def7..0000000
--- a/docs/Overview/What is Stirling-PDF.md
+++ /dev/null
@@ -1,28 +0,0 @@
----
-sidebar_position: 0
-slug: /
----
-
-
-
-# Introduction to Stirling PDF
-
-Stirling PDF is a robust, locally hosted, web-based PDF manipulation platform powered by Docker. Our application offers an extensive range of functionalities, from simple operations like merging and splitting PDFs, to advanced features such as compressing, OCR and Conversions.
-
-[Get started with Stirling PDF!](/Overview/Getting%20Started)
-
-# Benefits
-
-## Privacy comes first
-Originally developed as a purely ChatGPT-powered application, Stirling PDF has evolved to accommodate a plethora of PDF-related needs. Most importantly, the platform guarantees privacy and security as it doesn't make outbound calls for file processing ensuring file data is safe. All files and PDFs remain either on the client side, stored temporarily on the server during the execution of tasks, or within a transient file created specifically for task execution. Once the user downloads a file, it is immediately purged from the server.
-
-
-## Always improving
-Stirling-PDF has a active community of users giving new ideas and helping as part of its open source nature. New features are added throughout the year continuously involving Stirling-PDF as an application.
-
-## Options
-Stirling-PDF is yours.
-You are free to do with it what you like and customize it however you wish. We offer various [customization features](/Advanced%20Configuration/How%20to%20add%20configurations) for you or your business.
-
-
-Please feel free to request new features or report bugs through our GitHub issues or [Discord](https://discord.gg/Cn8pWhQRxZ).
diff --git a/docs/Overview/_category_.json b/docs/Overview/_category_.json
deleted file mode 100644
index 8156bea..0000000
--- a/docs/Overview/_category_.json
+++ /dev/null
@@ -1,3 +0,0 @@
-{
- "position": 1
-}