WIP skeleton for new docs.

This commit is contained in:
Miroslav Šedivý 2025-02-08 20:30:50 +01:00
parent b23ca1af04
commit 4fad1b5a57
43 changed files with 277 additions and 0 deletions

View file

@ -0,0 +1,4 @@
{
"position": 5,
"label": "Advanced Topics"
}

View file

@ -0,0 +1,7 @@
---
sidebar_position: 3
---
# Customizing the UI
Modifying Nekos interface, branding, and user experience.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 4
---
# Logging & Monitoring
How to track logs and monitor system performance.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 2
---
# Networking
Required network settings and firewall rules for smooth operation.

View file

@ -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).

View file

@ -0,0 +1,4 @@
{
"position": 4,
"label": "Application Customization"
}

View file

@ -0,0 +1,7 @@
---
sidebar_position: 1
---
# Chromium-based Browsers
Custom settings, bookmarks, and persistence across sessions.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 2
---
# Firefox Customization
Specific tweaks for running and configuring Firefox in Neko.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 3
---
# Persistent Data Storage
How to persist browser data (history, bookmarks, extensions) across sessions.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 4
---
# WebRTC Configuration
Adjusting WebRTC settings for different browsers and improving compatibility.

View file

@ -0,0 +1,4 @@
{
"position": 9,
"label": "Changelog & Releases"
}

View file

@ -0,0 +1,7 @@
---
sidebar_position: 2
---
# Deprecated Features
Features that have been removed or replaced and migration tips.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 1
---
# Release Notes
A list of features, improvements, and fixes in each release.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 3
---
# Roadmap
Planned features and upcoming changes for future releases.

View file

@ -0,0 +1,4 @@
{
"position": 7,
"label": "Deployment & Scaling"
}

View file

@ -0,0 +1,7 @@
---
sidebar_position: 3
---
# CI/CD Pipelines
Automating deployments using CI/CD workflows.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 2
---
# Kubernetes & Helm Chart Deployment
How to deploy and manage Neko using Kubernetes and Helm.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 4
---
# Load Balancing & High Availability
Scaling Neko for high-traffic use cases.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 1
---
# Self-Hosting on Linux
Deploying and maintaining Neko on bare metal or virtual machines.

View file

@ -0,0 +1,4 @@
{
"position": 6,
"label": "Developer Guide"
}

View file

@ -0,0 +1,7 @@
---
sidebar_position: 4
---
# API Reference
Documentation of available APIs for integrating with Neko (WebSocket, REST, etc.).

View file

@ -0,0 +1,7 @@
---
sidebar_position: 2
---
# Building from Source
How to compile and run Neko from the source code.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 1
---
# Code Structure
Explanation of the projects architecture and key components.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 6
---
# Contributing Guide
How to contribute to the project, submit patches, and report issues.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 3
---
# Running in Development Mode
Setting up a development environment for contributing.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 7
---
# Style Guide
Code formatting, linting, and other development conventions.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 5
---
# Testing & Debugging
Debugging tools, test cases, and best practices for troubleshooting.

View file

@ -0,0 +1,4 @@
{
"position": 3,
"label": "Hardware Acceleration"
}

View file

@ -0,0 +1,7 @@
---
sidebar_position: 3
---
# AMD GPU Support
Configuring VA-API for AMD GPUs and optimizing performance.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 1
---
# GPU Acceleration Overview
Benefits of hardware acceleration and when to use it.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 4
---
# Intel Quick Sync (QSV)
How to enable Quick Sync Video for Intel-based encoding.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 2
---
# NVIDIA GPU Support
Using CUDA/NVENC for hardware encoding in Docker and native installations.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 5
---
# Raspberry Pi GPU Acceleration
Enabling hardware acceleration on Raspberry Pi with VideoCore.

View file

@ -0,0 +1,4 @@
{
"position": 8,
"label": "Integration & Extensibility"
}

View file

@ -0,0 +1,7 @@
---
sidebar_position: 2
---
# Automating with Webhooks
Using webhooks to trigger actions in response to Neko events.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 3
---
# Custom Configurations
Advanced settings and custom scripts for extending Nekos functionality.

View file

@ -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.

View file

@ -0,0 +1,4 @@
{
"position": 2,
"label": "User Guide"
}

View file

@ -0,0 +1,7 @@
---
sidebar_position: 3
---
# Authentication & User Roles
Configuring authentication, user roles, and access permissions.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 1
---
# Connecting & Using Neko
How users can connect to a Neko session and interact with it.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 2
---
# Managing Sessions
Guide to starting, stopping, and managing Neko sessions.

View file

@ -0,0 +1,7 @@
---
sidebar_position: 4
---
# Performance Tuning
Optimizing video quality, latency, and encoding settings (Low Latency, Encoding, etc.).

View file

@ -0,0 +1,7 @@
---
sidebar_position: 5
---
# Security Best Practices
Tips for securing a Neko deployment, including encryption and firewall settings.