diff --git a/README.md b/README.md index f0386e47..c09b337b 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,38 @@ -# This documentation is still in progress. - # Operaton Documentation -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +This repository contains the public documentation website for [Operaton](https://operaton.org/), built with [Docusaurus](https://docusaurus.io/). + +## Requirements + +- Node.js 18 or newer +- npm -### Installation +## Install ```bash -npm install +npm ci ``` -### Local Development +## Local Development ```bash npm run 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. +This starts a local development server. Most content and styling changes are reflected without restarting the server. -### Build +## Build ```bash npm run build ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. +The static site is generated in the `build` directory. -### Update dependencies +## Typecheck ```bash -npm update +npm run typecheck ``` -This command update the dependencies from `package.json` \ No newline at end of file +Run the typecheck and production build before opening a pull request. diff --git a/docs/intro.md b/docs/intro.md deleted file mode 100644 index 45e8604c..00000000 --- a/docs/intro.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Tutorial Intro - -Let's discover **Docusaurus in less than 5 minutes**. - -## Getting Started - -Get started by **creating a new site**. - -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. - -### What you'll need - -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. - -## Generate a new site - -Generate a new Docusaurus site using the **classic template**. - -The classic template will automatically be added to your project after you run the command: - -```bash -npm init docusaurus@latest my-website classic -``` - -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. - -The command also installs all necessary dependencies you need to run Docusaurus. - -## Start your site - -Run the development server: - -```bash -cd my-website -npm run start -``` - -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. - -The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. - -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/src/components/HomepageFeatures/index.tsx b/src/components/HomepageFeatures/index.tsx index 84b5c1e9..77dcd2b2 100644 --- a/src/components/HomepageFeatures/index.tsx +++ b/src/components/HomepageFeatures/index.tsx @@ -13,7 +13,7 @@ const FeatureList: FeatureItem[] = [ title: 'Easy to Use', description: ( <> - Operaton as fork of Camunda 7 was designed from the ground up to be easily installed and used, helping you get your business processes up and running quickly. + Operaton builds on the Camunda 7 codebase and keeps BPMN process automation approachable for teams getting started or migrating existing workloads. ), }, @@ -35,7 +35,7 @@ const FeatureList: FeatureItem[] = [ }, ]; -function Feature({title, Svg, description}: FeatureItem) { +function Feature({title, description}: FeatureItem) { return (
diff --git a/src/components/HomepageFeatures/styles.module.css b/src/components/HomepageFeatures/styles.module.css index b248eb2e..2132b3d1 100644 --- a/src/components/HomepageFeatures/styles.module.css +++ b/src/components/HomepageFeatures/styles.module.css @@ -4,8 +4,3 @@ padding: 2rem 0; width: 100%; } - -.featureSvg { - height: 200px; - width: 200px; -} diff --git a/src/css/custom.css b/src/css/custom.css index bff5db60..3bcdc73b 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -1,10 +1,7 @@ /** - * Any CSS included here will be global. The classic template - * bundles Infima by default. Infima is a CSS framework designed to - * work well for content-centric websites. + * Global site styles and Infima theme variables. */ -/* You can override the default Infima variables here. */ :root { --ifm-color-primary: #0f7b9d; --ifm-color-primary-dark: #0a607c; @@ -18,7 +15,6 @@ --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); } -/* For readability concerns, you should choose a lighter palette in dark mode. */ [data-theme='dark'] { --ifm-color-primary: #25c2a0; --ifm-color-primary-dark: #21af90; @@ -42,4 +38,4 @@ .implemented td { color: #df8a13; -} \ No newline at end of file +} diff --git a/src/pages/index.module.css b/src/pages/index.module.css index 9f71a5da..6eeb1f44 100644 --- a/src/pages/index.module.css +++ b/src/pages/index.module.css @@ -20,4 +20,7 @@ display: flex; align-items: center; justify-content: center; + gap: 1rem; + flex-wrap: wrap; + margin-top: 1.5rem; } diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 167878c4..8a276536 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -17,6 +17,14 @@ function HomepageHeader() { {siteConfig.title}

{siteConfig.tagline}

+
+ + Get Started + + + Browse Documentation + +
); @@ -26,8 +34,8 @@ export default function Home(): ReactNode { const {siteConfig} = useDocusaurusContext(); return ( + title={siteConfig.title} + description="Operaton documentation for BPMN, DMN, CMMN, installation, operations, and APIs.">
diff --git a/src/theme/AnnouncementBar/index.tsx b/src/theme/AnnouncementBar/index.tsx deleted file mode 100644 index 9b71e24f..00000000 --- a/src/theme/AnnouncementBar/index.tsx +++ /dev/null @@ -1,20 +0,0 @@ - -// File: src/theme/AnnouncementBar/index.tsx -import React from 'react'; -import styles from './styles.module.css'; - -export interface AnnouncementBarProps { - // Define props if needed -} - -function AnnouncementBar(props: AnnouncementBarProps): React.ReactElement { - return ( -
-
- 🚧 This documentation is a work in progress 🚧 -
-
- ); -} - -export default AnnouncementBar; \ No newline at end of file diff --git a/src/theme/AnnouncementBar/styles.module.css b/src/theme/AnnouncementBar/styles.module.css deleted file mode 100644 index 749adb59..00000000 --- a/src/theme/AnnouncementBar/styles.module.css +++ /dev/null @@ -1,31 +0,0 @@ -/* File: src/theme/AnnouncementBar/styles.module.css */ -.announcementBar { - background-color: #ffd43b; - color: #1a1a1a; - font-weight: bold; - text-align: center; - padding: 0.5rem 1rem; - position: sticky; - top: 0; - z-index: 100; - width: 100%; - } - - .announcementBarContent { - font-size: 1rem; - display: flex; - align-items: center; - justify-content: center; - gap: 0.5rem; - } - - /* Optional: Add animation or pulsing effect */ - @keyframes pulse { - 0% { opacity: 0.8; } - 50% { opacity: 1; } - 100% { opacity: 0.8; } - } - - .announcementBar { - animation: pulse 2s infinite ease-in-out; - } \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json index 920d7a65..ae701a6d 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -2,7 +2,8 @@ // This file is not used in compilation. It is here just for a nice editor experience. "extends": "@docusaurus/tsconfig", "compilerOptions": { - "baseUrl": "." + "baseUrl": ".", + "ignoreDeprecations": "6.0" }, "exclude": [".docusaurus", "build"] }