From 4fad1b5a577183cf14b02c533e90d6bc46326b91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miroslav=20=C5=A0ediv=C3=BD?= Date: Sat, 8 Feb 2025 20:30:50 +0100 Subject: [PATCH] WIP skeleton for new docs. --- webpage/docs/advanced-topics/_category_.json | 4 ++++ webpage/docs/advanced-topics/customizing-ui.md | 7 +++++++ webpage/docs/advanced-topics/logging-monitoring.md | 7 +++++++ webpage/docs/advanced-topics/networking.md | 7 +++++++ webpage/docs/advanced-topics/reverse-proxy-setup.md | 7 +++++++ webpage/docs/app-customization/_category_.json | 4 ++++ webpage/docs/app-customization/chromium-browsers.md | 7 +++++++ webpage/docs/app-customization/firefox-customization.md | 7 +++++++ webpage/docs/app-customization/persistent-data-storage.md | 7 +++++++ webpage/docs/app-customization/webrtc-configuration.md | 7 +++++++ webpage/docs/changelog-and-releases/_category_.json | 4 ++++ webpage/docs/changelog-and-releases/deprecated-features.md | 7 +++++++ webpage/docs/changelog-and-releases/release-notes.md | 7 +++++++ webpage/docs/changelog-and-releases/roadmap.md | 7 +++++++ webpage/docs/deployment-and-scaling/_category_.json | 4 ++++ webpage/docs/deployment-and-scaling/cicd-pipelines.md | 7 +++++++ .../deployment-and-scaling/kubernetes-helm-deployment.md | 7 +++++++ webpage/docs/deployment-and-scaling/load-balancing-ha.md | 7 +++++++ webpage/docs/deployment-and-scaling/self-hosting-linux.md | 7 +++++++ webpage/docs/developer-guide/_category_.json | 4 ++++ webpage/docs/developer-guide/api-reference.md | 7 +++++++ webpage/docs/developer-guide/building-from-source.md | 7 +++++++ webpage/docs/developer-guide/code-structure.md | 7 +++++++ webpage/docs/developer-guide/contributing-guide.md | 7 +++++++ webpage/docs/developer-guide/development-mode.md | 7 +++++++ webpage/docs/developer-guide/style-guide.md | 7 +++++++ webpage/docs/developer-guide/testing-debugging.md | 7 +++++++ webpage/docs/hardware-acceleration/_category_.json | 4 ++++ webpage/docs/hardware-acceleration/amd-gpu-support.md | 7 +++++++ .../hardware-acceleration/gpu-acceleration-overview.md | 7 +++++++ webpage/docs/hardware-acceleration/intel-qsv.md | 7 +++++++ webpage/docs/hardware-acceleration/nvidia-gpu-support.md | 7 +++++++ webpage/docs/hardware-acceleration/raspberry-pi.md | 7 +++++++ webpage/docs/integration-and-extensibility/_category_.json | 4 ++++ .../automating-with-webhooks.md | 7 +++++++ .../integration-and-extensibility/custom-configurations.md | 7 +++++++ .../docs/integration-and-extensibility/embedding-neko.md | 7 +++++++ webpage/docs/user-guide/_category_.json | 4 ++++ webpage/docs/user-guide/authentication-and-roles.md | 7 +++++++ webpage/docs/user-guide/connecting-and-using-neko.md | 7 +++++++ webpage/docs/user-guide/managing-sessions.md | 7 +++++++ webpage/docs/user-guide/performance-tuning.md | 7 +++++++ webpage/docs/user-guide/security-best-practices.md | 7 +++++++ 43 files changed, 277 insertions(+) create mode 100644 webpage/docs/advanced-topics/_category_.json create mode 100644 webpage/docs/advanced-topics/customizing-ui.md create mode 100644 webpage/docs/advanced-topics/logging-monitoring.md create mode 100644 webpage/docs/advanced-topics/networking.md create mode 100644 webpage/docs/advanced-topics/reverse-proxy-setup.md create mode 100644 webpage/docs/app-customization/_category_.json create mode 100644 webpage/docs/app-customization/chromium-browsers.md create mode 100644 webpage/docs/app-customization/firefox-customization.md create mode 100644 webpage/docs/app-customization/persistent-data-storage.md create mode 100644 webpage/docs/app-customization/webrtc-configuration.md create mode 100644 webpage/docs/changelog-and-releases/_category_.json create mode 100644 webpage/docs/changelog-and-releases/deprecated-features.md create mode 100644 webpage/docs/changelog-and-releases/release-notes.md create mode 100644 webpage/docs/changelog-and-releases/roadmap.md create mode 100644 webpage/docs/deployment-and-scaling/_category_.json create mode 100644 webpage/docs/deployment-and-scaling/cicd-pipelines.md create mode 100644 webpage/docs/deployment-and-scaling/kubernetes-helm-deployment.md create mode 100644 webpage/docs/deployment-and-scaling/load-balancing-ha.md create mode 100644 webpage/docs/deployment-and-scaling/self-hosting-linux.md create mode 100644 webpage/docs/developer-guide/_category_.json create mode 100644 webpage/docs/developer-guide/api-reference.md create mode 100644 webpage/docs/developer-guide/building-from-source.md create mode 100644 webpage/docs/developer-guide/code-structure.md create mode 100644 webpage/docs/developer-guide/contributing-guide.md create mode 100644 webpage/docs/developer-guide/development-mode.md create mode 100644 webpage/docs/developer-guide/style-guide.md create mode 100644 webpage/docs/developer-guide/testing-debugging.md create mode 100644 webpage/docs/hardware-acceleration/_category_.json create mode 100644 webpage/docs/hardware-acceleration/amd-gpu-support.md create mode 100644 webpage/docs/hardware-acceleration/gpu-acceleration-overview.md create mode 100644 webpage/docs/hardware-acceleration/intel-qsv.md create mode 100644 webpage/docs/hardware-acceleration/nvidia-gpu-support.md create mode 100644 webpage/docs/hardware-acceleration/raspberry-pi.md create mode 100644 webpage/docs/integration-and-extensibility/_category_.json create mode 100644 webpage/docs/integration-and-extensibility/automating-with-webhooks.md create mode 100644 webpage/docs/integration-and-extensibility/custom-configurations.md create mode 100644 webpage/docs/integration-and-extensibility/embedding-neko.md create mode 100644 webpage/docs/user-guide/_category_.json create mode 100644 webpage/docs/user-guide/authentication-and-roles.md create mode 100644 webpage/docs/user-guide/connecting-and-using-neko.md create mode 100644 webpage/docs/user-guide/managing-sessions.md create mode 100644 webpage/docs/user-guide/performance-tuning.md create mode 100644 webpage/docs/user-guide/security-best-practices.md diff --git a/webpage/docs/advanced-topics/_category_.json b/webpage/docs/advanced-topics/_category_.json new file mode 100644 index 00000000..31371cdf --- /dev/null +++ b/webpage/docs/advanced-topics/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 5, + "label": "Advanced Topics" +} diff --git a/webpage/docs/advanced-topics/customizing-ui.md b/webpage/docs/advanced-topics/customizing-ui.md new file mode 100644 index 00000000..278a6b48 --- /dev/null +++ b/webpage/docs/advanced-topics/customizing-ui.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# Customizing the UI + +Modifying Neko’s interface, branding, and user experience. diff --git a/webpage/docs/advanced-topics/logging-monitoring.md b/webpage/docs/advanced-topics/logging-monitoring.md new file mode 100644 index 00000000..d2b4e5b5 --- /dev/null +++ b/webpage/docs/advanced-topics/logging-monitoring.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 4 +--- + +# Logging & Monitoring + +How to track logs and monitor system performance. diff --git a/webpage/docs/advanced-topics/networking.md b/webpage/docs/advanced-topics/networking.md new file mode 100644 index 00000000..a74c0d8b --- /dev/null +++ b/webpage/docs/advanced-topics/networking.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# Networking + +Required network settings and firewall rules for smooth operation. diff --git a/webpage/docs/advanced-topics/reverse-proxy-setup.md b/webpage/docs/advanced-topics/reverse-proxy-setup.md new file mode 100644 index 00000000..3f41d806 --- /dev/null +++ b/webpage/docs/advanced-topics/reverse-proxy-setup.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# Reverse Proxy Setup + +Setting up a reverse proxy for SSL termination and domain-based access (NGINX, Caddy, Traefik). diff --git a/webpage/docs/app-customization/_category_.json b/webpage/docs/app-customization/_category_.json new file mode 100644 index 00000000..a2ec7081 --- /dev/null +++ b/webpage/docs/app-customization/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 4, + "label": "Application Customization" +} diff --git a/webpage/docs/app-customization/chromium-browsers.md b/webpage/docs/app-customization/chromium-browsers.md new file mode 100644 index 00000000..e89e1928 --- /dev/null +++ b/webpage/docs/app-customization/chromium-browsers.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# Chromium-based Browsers + +Custom settings, bookmarks, and persistence across sessions. diff --git a/webpage/docs/app-customization/firefox-customization.md b/webpage/docs/app-customization/firefox-customization.md new file mode 100644 index 00000000..3b61efc6 --- /dev/null +++ b/webpage/docs/app-customization/firefox-customization.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# Firefox Customization + +Specific tweaks for running and configuring Firefox in Neko. diff --git a/webpage/docs/app-customization/persistent-data-storage.md b/webpage/docs/app-customization/persistent-data-storage.md new file mode 100644 index 00000000..3bd40ea4 --- /dev/null +++ b/webpage/docs/app-customization/persistent-data-storage.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# Persistent Data Storage + +How to persist browser data (history, bookmarks, extensions) across sessions. diff --git a/webpage/docs/app-customization/webrtc-configuration.md b/webpage/docs/app-customization/webrtc-configuration.md new file mode 100644 index 00000000..2f31d828 --- /dev/null +++ b/webpage/docs/app-customization/webrtc-configuration.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 4 +--- + +# WebRTC Configuration + +Adjusting WebRTC settings for different browsers and improving compatibility. diff --git a/webpage/docs/changelog-and-releases/_category_.json b/webpage/docs/changelog-and-releases/_category_.json new file mode 100644 index 00000000..a08c0691 --- /dev/null +++ b/webpage/docs/changelog-and-releases/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 9, + "label": "Changelog & Releases" +} diff --git a/webpage/docs/changelog-and-releases/deprecated-features.md b/webpage/docs/changelog-and-releases/deprecated-features.md new file mode 100644 index 00000000..480e5914 --- /dev/null +++ b/webpage/docs/changelog-and-releases/deprecated-features.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# Deprecated Features + +Features that have been removed or replaced and migration tips. diff --git a/webpage/docs/changelog-and-releases/release-notes.md b/webpage/docs/changelog-and-releases/release-notes.md new file mode 100644 index 00000000..c4619f7a --- /dev/null +++ b/webpage/docs/changelog-and-releases/release-notes.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# Release Notes + +A list of features, improvements, and fixes in each release. diff --git a/webpage/docs/changelog-and-releases/roadmap.md b/webpage/docs/changelog-and-releases/roadmap.md new file mode 100644 index 00000000..ca77cc4e --- /dev/null +++ b/webpage/docs/changelog-and-releases/roadmap.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# Roadmap + +Planned features and upcoming changes for future releases. diff --git a/webpage/docs/deployment-and-scaling/_category_.json b/webpage/docs/deployment-and-scaling/_category_.json new file mode 100644 index 00000000..d438494d --- /dev/null +++ b/webpage/docs/deployment-and-scaling/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 7, + "label": "Deployment & Scaling" +} diff --git a/webpage/docs/deployment-and-scaling/cicd-pipelines.md b/webpage/docs/deployment-and-scaling/cicd-pipelines.md new file mode 100644 index 00000000..8a1c4bde --- /dev/null +++ b/webpage/docs/deployment-and-scaling/cicd-pipelines.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# CI/CD Pipelines + +Automating deployments using CI/CD workflows. diff --git a/webpage/docs/deployment-and-scaling/kubernetes-helm-deployment.md b/webpage/docs/deployment-and-scaling/kubernetes-helm-deployment.md new file mode 100644 index 00000000..30093aff --- /dev/null +++ b/webpage/docs/deployment-and-scaling/kubernetes-helm-deployment.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# Kubernetes & Helm Chart Deployment + +How to deploy and manage Neko using Kubernetes and Helm. diff --git a/webpage/docs/deployment-and-scaling/load-balancing-ha.md b/webpage/docs/deployment-and-scaling/load-balancing-ha.md new file mode 100644 index 00000000..3a31da0b --- /dev/null +++ b/webpage/docs/deployment-and-scaling/load-balancing-ha.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 4 +--- + +# Load Balancing & High Availability + +Scaling Neko for high-traffic use cases. diff --git a/webpage/docs/deployment-and-scaling/self-hosting-linux.md b/webpage/docs/deployment-and-scaling/self-hosting-linux.md new file mode 100644 index 00000000..27a8f726 --- /dev/null +++ b/webpage/docs/deployment-and-scaling/self-hosting-linux.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# Self-Hosting on Linux + +Deploying and maintaining Neko on bare metal or virtual machines. diff --git a/webpage/docs/developer-guide/_category_.json b/webpage/docs/developer-guide/_category_.json new file mode 100644 index 00000000..a754adf3 --- /dev/null +++ b/webpage/docs/developer-guide/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 6, + "label": "Developer Guide" +} diff --git a/webpage/docs/developer-guide/api-reference.md b/webpage/docs/developer-guide/api-reference.md new file mode 100644 index 00000000..ea634205 --- /dev/null +++ b/webpage/docs/developer-guide/api-reference.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 4 +--- + +# API Reference + +Documentation of available APIs for integrating with Neko (WebSocket, REST, etc.). diff --git a/webpage/docs/developer-guide/building-from-source.md b/webpage/docs/developer-guide/building-from-source.md new file mode 100644 index 00000000..9259f8d2 --- /dev/null +++ b/webpage/docs/developer-guide/building-from-source.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# Building from Source + +How to compile and run Neko from the source code. diff --git a/webpage/docs/developer-guide/code-structure.md b/webpage/docs/developer-guide/code-structure.md new file mode 100644 index 00000000..57ac0b26 --- /dev/null +++ b/webpage/docs/developer-guide/code-structure.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# Code Structure + +Explanation of the project’s architecture and key components. diff --git a/webpage/docs/developer-guide/contributing-guide.md b/webpage/docs/developer-guide/contributing-guide.md new file mode 100644 index 00000000..8fa0e43c --- /dev/null +++ b/webpage/docs/developer-guide/contributing-guide.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 6 +--- + +# Contributing Guide + +How to contribute to the project, submit patches, and report issues. diff --git a/webpage/docs/developer-guide/development-mode.md b/webpage/docs/developer-guide/development-mode.md new file mode 100644 index 00000000..ffe525a7 --- /dev/null +++ b/webpage/docs/developer-guide/development-mode.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# Running in Development Mode + +Setting up a development environment for contributing. diff --git a/webpage/docs/developer-guide/style-guide.md b/webpage/docs/developer-guide/style-guide.md new file mode 100644 index 00000000..1198e0be --- /dev/null +++ b/webpage/docs/developer-guide/style-guide.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 7 +--- + +# Style Guide + +Code formatting, linting, and other development conventions. diff --git a/webpage/docs/developer-guide/testing-debugging.md b/webpage/docs/developer-guide/testing-debugging.md new file mode 100644 index 00000000..71778ae1 --- /dev/null +++ b/webpage/docs/developer-guide/testing-debugging.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 5 +--- + +# Testing & Debugging + +Debugging tools, test cases, and best practices for troubleshooting. diff --git a/webpage/docs/hardware-acceleration/_category_.json b/webpage/docs/hardware-acceleration/_category_.json new file mode 100644 index 00000000..93c42ab9 --- /dev/null +++ b/webpage/docs/hardware-acceleration/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 3, + "label": "Hardware Acceleration" +} diff --git a/webpage/docs/hardware-acceleration/amd-gpu-support.md b/webpage/docs/hardware-acceleration/amd-gpu-support.md new file mode 100644 index 00000000..6bbd7ebd --- /dev/null +++ b/webpage/docs/hardware-acceleration/amd-gpu-support.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# AMD GPU Support + +Configuring VA-API for AMD GPUs and optimizing performance. diff --git a/webpage/docs/hardware-acceleration/gpu-acceleration-overview.md b/webpage/docs/hardware-acceleration/gpu-acceleration-overview.md new file mode 100644 index 00000000..c3dffeb9 --- /dev/null +++ b/webpage/docs/hardware-acceleration/gpu-acceleration-overview.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# GPU Acceleration Overview + +Benefits of hardware acceleration and when to use it. diff --git a/webpage/docs/hardware-acceleration/intel-qsv.md b/webpage/docs/hardware-acceleration/intel-qsv.md new file mode 100644 index 00000000..4f2e03c4 --- /dev/null +++ b/webpage/docs/hardware-acceleration/intel-qsv.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 4 +--- + +# Intel Quick Sync (QSV) + +How to enable Quick Sync Video for Intel-based encoding. diff --git a/webpage/docs/hardware-acceleration/nvidia-gpu-support.md b/webpage/docs/hardware-acceleration/nvidia-gpu-support.md new file mode 100644 index 00000000..c3ea264b --- /dev/null +++ b/webpage/docs/hardware-acceleration/nvidia-gpu-support.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# NVIDIA GPU Support + +Using CUDA/NVENC for hardware encoding in Docker and native installations. diff --git a/webpage/docs/hardware-acceleration/raspberry-pi.md b/webpage/docs/hardware-acceleration/raspberry-pi.md new file mode 100644 index 00000000..c5921c69 --- /dev/null +++ b/webpage/docs/hardware-acceleration/raspberry-pi.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 5 +--- + +# Raspberry Pi GPU Acceleration + +Enabling hardware acceleration on Raspberry Pi with VideoCore. diff --git a/webpage/docs/integration-and-extensibility/_category_.json b/webpage/docs/integration-and-extensibility/_category_.json new file mode 100644 index 00000000..6a5d3365 --- /dev/null +++ b/webpage/docs/integration-and-extensibility/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 8, + "label": "Integration & Extensibility" +} diff --git a/webpage/docs/integration-and-extensibility/automating-with-webhooks.md b/webpage/docs/integration-and-extensibility/automating-with-webhooks.md new file mode 100644 index 00000000..0428d6a0 --- /dev/null +++ b/webpage/docs/integration-and-extensibility/automating-with-webhooks.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# Automating with Webhooks + +Using webhooks to trigger actions in response to Neko events. diff --git a/webpage/docs/integration-and-extensibility/custom-configurations.md b/webpage/docs/integration-and-extensibility/custom-configurations.md new file mode 100644 index 00000000..922697fa --- /dev/null +++ b/webpage/docs/integration-and-extensibility/custom-configurations.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# Custom Configurations + +Advanced settings and custom scripts for extending Neko’s functionality. diff --git a/webpage/docs/integration-and-extensibility/embedding-neko.md b/webpage/docs/integration-and-extensibility/embedding-neko.md new file mode 100644 index 00000000..56b21446 --- /dev/null +++ b/webpage/docs/integration-and-extensibility/embedding-neko.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# Embedding Neko in Web Apps + +How to embed Neko as an iframe or integrate it into existing web applications. diff --git a/webpage/docs/user-guide/_category_.json b/webpage/docs/user-guide/_category_.json new file mode 100644 index 00000000..afa60306 --- /dev/null +++ b/webpage/docs/user-guide/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 2, + "label": "User Guide" +} diff --git a/webpage/docs/user-guide/authentication-and-roles.md b/webpage/docs/user-guide/authentication-and-roles.md new file mode 100644 index 00000000..ca188c12 --- /dev/null +++ b/webpage/docs/user-guide/authentication-and-roles.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# Authentication & User Roles + +Configuring authentication, user roles, and access permissions. diff --git a/webpage/docs/user-guide/connecting-and-using-neko.md b/webpage/docs/user-guide/connecting-and-using-neko.md new file mode 100644 index 00000000..ab14d45f --- /dev/null +++ b/webpage/docs/user-guide/connecting-and-using-neko.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# Connecting & Using Neko + +How users can connect to a Neko session and interact with it. diff --git a/webpage/docs/user-guide/managing-sessions.md b/webpage/docs/user-guide/managing-sessions.md new file mode 100644 index 00000000..6b20c069 --- /dev/null +++ b/webpage/docs/user-guide/managing-sessions.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# Managing Sessions + +Guide to starting, stopping, and managing Neko sessions. diff --git a/webpage/docs/user-guide/performance-tuning.md b/webpage/docs/user-guide/performance-tuning.md new file mode 100644 index 00000000..90db795c --- /dev/null +++ b/webpage/docs/user-guide/performance-tuning.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 4 +--- + +# Performance Tuning + +Optimizing video quality, latency, and encoding settings (Low Latency, Encoding, etc.). diff --git a/webpage/docs/user-guide/security-best-practices.md b/webpage/docs/user-guide/security-best-practices.md new file mode 100644 index 00000000..30f43bc1 --- /dev/null +++ b/webpage/docs/user-guide/security-best-practices.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 5 +--- + +# Security Best Practices + +Tips for securing a Neko deployment, including encryption and firewall settings.