osui-rs/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improved docs

Browse Source
This commit is contained in:
selimaj-dev
2026-01-31 21:01:30 +01:00
parent 6fe25f0320
commit 37d2de41ce
54 changed files with 2 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/intro/00-introduction.md → docs/00-intro/00-introduction.md
+1 -1
View File
@@ -1,7 +1,7 @@
markdown
--- ---
sidebar_position: 0 sidebar_position: 0
title: Introduction title: Introduction
slug: /
--- ---
# Introduction to OSUI # Introduction to OSUI
docs/intro/01-installation.md → docs/00-intro/01-installation.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 1 sidebar_position: 1
title: Installation title: Installation
docs/intro/02-getting-started.md → docs/00-intro/02-getting-started.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 2 sidebar_position: 2
title: Getting Started title: Getting Started
docs/intro/03-example-basic-component.md → docs/00-intro/03-example-basic-component.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 3 sidebar_position: 3
title: Basic Component with Children title: Basic Component with Children
versioned_docs/version-0.2.0/guides/00-creating-components.md → docs/01-guides/00-creating-components.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 0 sidebar_position: 0
title: Creating Components title: Creating Components
docs/guides/01-rsx-syntax.md → docs/01-guides/01-rsx-syntax.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 1 sidebar_position: 1
title: RSX Syntax Guide title: RSX Syntax Guide
docs/guides/02-state-management.md → docs/01-guides/02-state-management.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 2 sidebar_position: 2
title: State Management title: State Management
versioned_docs/version-0.2.0/guides/03-event-handling.md → docs/01-guides/03-event-handling.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 3 sidebar_position: 3
title: Event Handling title: Event Handling
versioned_docs/version-0.2.0/guides/04-lifecycle-hooks.md → docs/01-guides/04-lifecycle-hooks.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 4 sidebar_position: 4
title: Lifecycle Hooks title: Lifecycle Hooks
docs/guides/05-data-flow-and-sync.md → docs/01-guides/05-data-flow-and-sync.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 5 sidebar_position: 5
title: Data Flow and Sync title: Data Flow and Sync
docs/guides/06-building-complex-layouts.md → docs/01-guides/06-building-complex-layouts.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 6 sidebar_position: 6
title: Building Complex Layouts title: Building Complex Layouts
versioned_docs/version-0.2.0/reference/00-crate-structure.md → docs/02-reference/00-crate-structure.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 0 sidebar_position: 0
title: Crate Structure title: Crate Structure
docs/reference/component-api.md → docs/02-reference/component-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 1 sidebar_position: 1
title: Component API title: Component API
docs/reference/engine-api.md → docs/02-reference/engine-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 2 sidebar_position: 2
title: Engine API title: Engine API
versioned_docs/version-0.2.0/reference/frontend-api.md → docs/02-reference/frontend-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 3 sidebar_position: 3
title: Frontend API title: Frontend API
docs/reference/macros-api.md → docs/02-reference/macros-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 6 sidebar_position: 6
title: Macros API title: Macros API
docs/reference/render-api.md → docs/02-reference/render-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 4 sidebar_position: 4
title: Render API title: Render API
versioned_docs/version-0.2.0/reference/state-api.md → docs/02-reference/state-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 5 sidebar_position: 5
title: State API title: State API
docs/concepts/00-architecture.md → docs/03-concepts/00-architecture.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 0 sidebar_position: 0
title: Core Architecture title: Core Architecture
versioned_docs/version-0.2.0/concepts/01-the-component-model.md → docs/03-concepts/01-the-component-model.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 1 sidebar_position: 1
title: The Component Model title: The Component Model
versioned_docs/version-0.2.0/concepts/02-reactive-state-flow.md → docs/03-concepts/02-reactive-state-flow.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 2 sidebar_position: 2
title: Reactive State Flow title: Reactive State Flow
docs/concepts/03-event-propagation.md → docs/03-concepts/03-event-propagation.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 3 sidebar_position: 3
title: Event Propagation title: Event Propagation
versioned_docs/version-0.2.0/concepts/04-rendering-pipeline.md → docs/03-concepts/04-rendering-pipeline.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 4 sidebar_position: 4
title: The Rendering Pipeline title: The Rendering Pipeline
docs/advanced/00-performance-benchmarking.md → docs/04-advanced/00-performance-benchmarking.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 0 sidebar_position: 0
title: Performance Benchmarking title: Performance Benchmarking
versioned_docs/version-0.2.0/advanced/01-customizing-the-engine.md → docs/04-advanced/01-customizing-the-engine.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 1 sidebar_position: 1
title: Customizing the Engine title: Customizing the Engine
versioned_docs/version-0.2.0/advanced/02-internals-macros.md → docs/04-advanced/02-internals-macros.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 2 sidebar_position: 2
title: Internals: Macros title: Internals: Macros
versioned_docs/version-0.2.0/advanced/03-contributing.md → docs/04-advanced/03-contributing.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 3 sidebar_position: 3
title: Contributing title: Contributing
versioned_docs/version-0.2.0/intro/00-introduction.md → versioned_docs/version-0.2.0/00-intro/00-introduction.md
+1 -1
View File
@@ -1,7 +1,7 @@
markdown
--- ---
sidebar_position: 0 sidebar_position: 0
title: Introduction title: Introduction
slug: /
--- ---
# Introduction to OSUI # Introduction to OSUI
versioned_docs/version-0.2.0/intro/01-installation.md → versioned_docs/version-0.2.0/00-intro/01-installation.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 1 sidebar_position: 1
title: Installation title: Installation
versioned_docs/version-0.2.0/intro/02-getting-started.md → versioned_docs/version-0.2.0/00-intro/02-getting-started.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 2 sidebar_position: 2
title: Getting Started title: Getting Started
versioned_docs/version-0.2.0/intro/03-example-basic-component.md → versioned_docs/version-0.2.0/00-intro/03-example-basic-component.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 3 sidebar_position: 3
title: Basic Component with Children title: Basic Component with Children
docs/guides/00-creating-components.md → versioned_docs/version-0.2.0/01-guides/00-creating-components.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 0 sidebar_position: 0
title: Creating Components title: Creating Components
versioned_docs/version-0.2.0/guides/01-rsx-syntax.md → versioned_docs/version-0.2.0/01-guides/01-rsx-syntax.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 1 sidebar_position: 1
title: RSX Syntax Guide title: RSX Syntax Guide
versioned_docs/version-0.2.0/guides/02-state-management.md → versioned_docs/version-0.2.0/01-guides/02-state-management.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 2 sidebar_position: 2
title: State Management title: State Management
docs/guides/03-event-handling.md → versioned_docs/version-0.2.0/01-guides/03-event-handling.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 3 sidebar_position: 3
title: Event Handling title: Event Handling
docs/guides/04-lifecycle-hooks.md → versioned_docs/version-0.2.0/01-guides/04-lifecycle-hooks.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 4 sidebar_position: 4
title: Lifecycle Hooks title: Lifecycle Hooks
versioned_docs/version-0.2.0/guides/05-data-flow-and-sync.md → versioned_docs/version-0.2.0/01-guides/05-data-flow-and-sync.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 5 sidebar_position: 5
title: Data Flow and Sync title: Data Flow and Sync
versioned_docs/version-0.2.0/guides/06-building-complex-layouts.md → versioned_docs/version-0.2.0/01-guides/06-building-complex-layouts.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 6 sidebar_position: 6
title: Building Complex Layouts title: Building Complex Layouts
docs/reference/00-crate-structure.md → versioned_docs/version-0.2.0/02-reference/00-crate-structure.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 0 sidebar_position: 0
title: Crate Structure title: Crate Structure
versioned_docs/version-0.2.0/reference/component-api.md → versioned_docs/version-0.2.0/02-reference/component-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 1 sidebar_position: 1
title: Component API title: Component API
versioned_docs/version-0.2.0/reference/engine-api.md → versioned_docs/version-0.2.0/02-reference/engine-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 2 sidebar_position: 2
title: Engine API title: Engine API
docs/reference/frontend-api.md → versioned_docs/version-0.2.0/02-reference/frontend-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 3 sidebar_position: 3
title: Frontend API title: Frontend API
versioned_docs/version-0.2.0/reference/macros-api.md → versioned_docs/version-0.2.0/02-reference/macros-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 6 sidebar_position: 6
title: Macros API title: Macros API
versioned_docs/version-0.2.0/reference/render-api.md → versioned_docs/version-0.2.0/02-reference/render-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 4 sidebar_position: 4
title: Render API title: Render API
docs/reference/state-api.md → versioned_docs/version-0.2.0/02-reference/state-api.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 5 sidebar_position: 5
title: State API title: State API
versioned_docs/version-0.2.0/concepts/00-architecture.md → versioned_docs/version-0.2.0/03-concepts/00-architecture.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 0 sidebar_position: 0
title: Core Architecture title: Core Architecture
docs/concepts/01-the-component-model.md → versioned_docs/version-0.2.0/03-concepts/01-the-component-model.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 1 sidebar_position: 1
title: The Component Model title: The Component Model
docs/concepts/02-reactive-state-flow.md → versioned_docs/version-0.2.0/03-concepts/02-reactive-state-flow.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 2 sidebar_position: 2
title: Reactive State Flow title: Reactive State Flow
versioned_docs/version-0.2.0/concepts/03-event-propagation.md → versioned_docs/version-0.2.0/03-concepts/03-event-propagation.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 3 sidebar_position: 3
title: Event Propagation title: Event Propagation
docs/concepts/04-rendering-pipeline.md → versioned_docs/version-0.2.0/03-concepts/04-rendering-pipeline.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 4 sidebar_position: 4
title: The Rendering Pipeline title: The Rendering Pipeline
versioned_docs/version-0.2.0/advanced/00-performance-benchmarking.md → versioned_docs/version-0.2.0/04-advanced/00-performance-benchmarking.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 0 sidebar_position: 0
title: Performance Benchmarking title: Performance Benchmarking
docs/advanced/01-customizing-the-engine.md → versioned_docs/version-0.2.0/04-advanced/01-customizing-the-engine.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 1 sidebar_position: 1
title: Customizing the Engine title: Customizing the Engine
docs/advanced/02-internals-macros.md → versioned_docs/version-0.2.0/04-advanced/02-internals-macros.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 2 sidebar_position: 2
title: Internals: Macros title: Internals: Macros
docs/advanced/03-contributing.md → versioned_docs/version-0.2.0/04-advanced/03-contributing.md
-1
View File
@@ -1,4 +1,3 @@
markdown
--- ---
sidebar_position: 3 sidebar_position: 3
title: Contributing title: Contributing