From 6300cefc0b3004d14f98c5a277bbd51462f0a158 Mon Sep 17 00:00:00 2001 From: ismailbennani Date: Fri, 25 Apr 2025 00:04:32 +0200 Subject: [PATCH] remove getting started and create self-hosting --- docs/.vitepress/config.mts | 20 ++++++++++---------- docs/src/guides/getting-started.md | 6 ------ docs/src/guides/self-hosting.md | 6 ++++++ docs/src/guides/what-is-facturxdotnet.md | 24 +++++++++++++++++++++++- docs/src/index.md | 4 ++-- 5 files changed, 41 insertions(+), 19 deletions(-) delete mode 100644 docs/src/guides/getting-started.md create mode 100644 docs/src/guides/self-hosting.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index d4505fd4..034ed53b 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -1,9 +1,9 @@ -import { defineConfigWithTheme } from "vitepress"; // https://vitepress.dev/reference/site-config -import { useSidebar } from "vitepress-openapi"; -import { getSidebar } from "vitepress-plugin-auto-sidebar"; +import {defineConfigWithTheme} from "vitepress"; // https://vitepress.dev/reference/site-config +import {useSidebar} from "vitepress-openapi"; +import {getSidebar} from "vitepress-plugin-auto-sidebar"; import semver from "semver"; -import env from "../src/env.json" with { type: "json" }; -import spec from "../src/assets/facturxdotnet.openapi.json" with { type: "json" }; +import env from "../src/env.json" with {type: "json"}; +import spec from "../src/assets/facturxdotnet.openapi.json" with {type: "json"}; const specSidebar = useSidebar({ spec, @@ -84,7 +84,7 @@ export default defineConfigWithTheme({ nav: [ { text: "Home", link: "/" }, - { text: "Guides", link: "/guides/getting-started" }, + { text: "Guides", link: "/guides/what-is-facturxdotnet" }, { text: "Try it live!", items: [ @@ -121,10 +121,6 @@ export default defineConfigWithTheme({ text: "What is FacturX.NET?", link: "/guides/what-is-facturxdotnet", }, - { - text: "Getting started", - link: "/guides/getting-started", - }, { text: "Use cases", items: [ @@ -164,6 +160,10 @@ export default defineConfigWithTheme({ { text: "Extract XMP metadata", link: "/extraction/cii" }, ], }, + { + text: "Self-hosting", + link: "/guides/self-hosting", + }, ], }, { diff --git a/docs/src/guides/getting-started.md b/docs/src/guides/getting-started.md deleted file mode 100644 index 84a82194..00000000 --- a/docs/src/guides/getting-started.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Getting started -editLink: true ---- - -Hello there \ No newline at end of file diff --git a/docs/src/guides/self-hosting.md b/docs/src/guides/self-hosting.md new file mode 100644 index 00000000..e3b34997 --- /dev/null +++ b/docs/src/guides/self-hosting.md @@ -0,0 +1,6 @@ +--- +title: Self-hosting +editLink: true +--- + +TODO \ No newline at end of file diff --git a/docs/src/guides/what-is-facturxdotnet.md b/docs/src/guides/what-is-facturxdotnet.md index f7cde6bc..aec2307f 100644 --- a/docs/src/guides/what-is-facturxdotnet.md +++ b/docs/src/guides/what-is-facturxdotnet.md @@ -18,4 +18,26 @@ It comes in multiple flavors: - a web app: [app](https://editor.facturxdotnet.org) | [source](https://github.com/FacturX-NET/FacturXDotNet/tree/master/FacturXDotNet.WebEditor) - a .NET library: [nuget](https://www.nuget.org/packages/FacturXDotNet) | [source](https://github.com/FacturX-NET/FacturXDotNet/tree/master/FacturXDotNet) -All these tools provide the same set of [features](#features). \ No newline at end of file +## Features + +All these tools provide the same set of features. + +### Generation +#### [Generate a Factur-X document](/guides/generation/facturx) +#### [Generate a standard PDF](/guides/generation/standard-pdf) + +### Validation +#### [Validate a Factur-X document](/guides/validation/facturx) +#### [Validate Cross-Industry Invoice data](/guides/validation/cii) + +### Extraction +#### [Extract Cross-Industry Invoice data](/guides/extraction/cii) +#### [Extract XMP metadata](/guides/extraction/xmp) + +## Self-hosting + +The demo versions of the editor and API are intended for demonstration purposes only. They run on low-cost, limited, and insecure public cloud infrastructure. + +If you plan to use these tools in a production environment, we strongly recommend self-hosting them for better performance, security, and control. + +[Learn more aboute self-hosting >](/guides/self-hosting) \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md index f2387ff4..8c95611b 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -14,8 +14,8 @@ hero: text: What is FacturX.NET? link: /guides/what-is-facturxdotnet - theme: alt - text: Getting started - link: /guides/getting-started + text: Self-hosting + link: /guides/self-hosting - theme: alt text: GitHub link: https://github.com/FacturX-NET/FacturXDotNet