mirror of
https://github.com/m1k1o/neko.git
synced 2025-04-29 18:36:22 +02:00
WIP skeleton for new docs.
This commit is contained in:
parent
b23ca1af04
commit
4fad1b5a57
43 changed files with 277 additions and 0 deletions
4
webpage/docs/advanced-topics/_category_.json
Normal file
4
webpage/docs/advanced-topics/_category_.json
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"position": 5,
|
||||||
|
"label": "Advanced Topics"
|
||||||
|
}
|
7
webpage/docs/advanced-topics/customizing-ui.md
Normal file
7
webpage/docs/advanced-topics/customizing-ui.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Customizing the UI
|
||||||
|
|
||||||
|
Modifying Neko’s interface, branding, and user experience.
|
7
webpage/docs/advanced-topics/logging-monitoring.md
Normal file
7
webpage/docs/advanced-topics/logging-monitoring.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 4
|
||||||
|
---
|
||||||
|
|
||||||
|
# Logging & Monitoring
|
||||||
|
|
||||||
|
How to track logs and monitor system performance.
|
7
webpage/docs/advanced-topics/networking.md
Normal file
7
webpage/docs/advanced-topics/networking.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Networking
|
||||||
|
|
||||||
|
Required network settings and firewall rules for smooth operation.
|
7
webpage/docs/advanced-topics/reverse-proxy-setup.md
Normal file
7
webpage/docs/advanced-topics/reverse-proxy-setup.md
Normal 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).
|
4
webpage/docs/app-customization/_category_.json
Normal file
4
webpage/docs/app-customization/_category_.json
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"position": 4,
|
||||||
|
"label": "Application Customization"
|
||||||
|
}
|
7
webpage/docs/app-customization/chromium-browsers.md
Normal file
7
webpage/docs/app-customization/chromium-browsers.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# Chromium-based Browsers
|
||||||
|
|
||||||
|
Custom settings, bookmarks, and persistence across sessions.
|
7
webpage/docs/app-customization/firefox-customization.md
Normal file
7
webpage/docs/app-customization/firefox-customization.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Firefox Customization
|
||||||
|
|
||||||
|
Specific tweaks for running and configuring Firefox in Neko.
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Persistent Data Storage
|
||||||
|
|
||||||
|
How to persist browser data (history, bookmarks, extensions) across sessions.
|
7
webpage/docs/app-customization/webrtc-configuration.md
Normal file
7
webpage/docs/app-customization/webrtc-configuration.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 4
|
||||||
|
---
|
||||||
|
|
||||||
|
# WebRTC Configuration
|
||||||
|
|
||||||
|
Adjusting WebRTC settings for different browsers and improving compatibility.
|
4
webpage/docs/changelog-and-releases/_category_.json
Normal file
4
webpage/docs/changelog-and-releases/_category_.json
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"position": 9,
|
||||||
|
"label": "Changelog & Releases"
|
||||||
|
}
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Deprecated Features
|
||||||
|
|
||||||
|
Features that have been removed or replaced and migration tips.
|
7
webpage/docs/changelog-and-releases/release-notes.md
Normal file
7
webpage/docs/changelog-and-releases/release-notes.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# Release Notes
|
||||||
|
|
||||||
|
A list of features, improvements, and fixes in each release.
|
7
webpage/docs/changelog-and-releases/roadmap.md
Normal file
7
webpage/docs/changelog-and-releases/roadmap.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Roadmap
|
||||||
|
|
||||||
|
Planned features and upcoming changes for future releases.
|
4
webpage/docs/deployment-and-scaling/_category_.json
Normal file
4
webpage/docs/deployment-and-scaling/_category_.json
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"position": 7,
|
||||||
|
"label": "Deployment & Scaling"
|
||||||
|
}
|
7
webpage/docs/deployment-and-scaling/cicd-pipelines.md
Normal file
7
webpage/docs/deployment-and-scaling/cicd-pipelines.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# CI/CD Pipelines
|
||||||
|
|
||||||
|
Automating deployments using CI/CD workflows.
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Kubernetes & Helm Chart Deployment
|
||||||
|
|
||||||
|
How to deploy and manage Neko using Kubernetes and Helm.
|
7
webpage/docs/deployment-and-scaling/load-balancing-ha.md
Normal file
7
webpage/docs/deployment-and-scaling/load-balancing-ha.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 4
|
||||||
|
---
|
||||||
|
|
||||||
|
# Load Balancing & High Availability
|
||||||
|
|
||||||
|
Scaling Neko for high-traffic use cases.
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# Self-Hosting on Linux
|
||||||
|
|
||||||
|
Deploying and maintaining Neko on bare metal or virtual machines.
|
4
webpage/docs/developer-guide/_category_.json
Normal file
4
webpage/docs/developer-guide/_category_.json
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"position": 6,
|
||||||
|
"label": "Developer Guide"
|
||||||
|
}
|
7
webpage/docs/developer-guide/api-reference.md
Normal file
7
webpage/docs/developer-guide/api-reference.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 4
|
||||||
|
---
|
||||||
|
|
||||||
|
# API Reference
|
||||||
|
|
||||||
|
Documentation of available APIs for integrating with Neko (WebSocket, REST, etc.).
|
7
webpage/docs/developer-guide/building-from-source.md
Normal file
7
webpage/docs/developer-guide/building-from-source.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Building from Source
|
||||||
|
|
||||||
|
How to compile and run Neko from the source code.
|
7
webpage/docs/developer-guide/code-structure.md
Normal file
7
webpage/docs/developer-guide/code-structure.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# Code Structure
|
||||||
|
|
||||||
|
Explanation of the project’s architecture and key components.
|
7
webpage/docs/developer-guide/contributing-guide.md
Normal file
7
webpage/docs/developer-guide/contributing-guide.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 6
|
||||||
|
---
|
||||||
|
|
||||||
|
# Contributing Guide
|
||||||
|
|
||||||
|
How to contribute to the project, submit patches, and report issues.
|
7
webpage/docs/developer-guide/development-mode.md
Normal file
7
webpage/docs/developer-guide/development-mode.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Running in Development Mode
|
||||||
|
|
||||||
|
Setting up a development environment for contributing.
|
7
webpage/docs/developer-guide/style-guide.md
Normal file
7
webpage/docs/developer-guide/style-guide.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 7
|
||||||
|
---
|
||||||
|
|
||||||
|
# Style Guide
|
||||||
|
|
||||||
|
Code formatting, linting, and other development conventions.
|
7
webpage/docs/developer-guide/testing-debugging.md
Normal file
7
webpage/docs/developer-guide/testing-debugging.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 5
|
||||||
|
---
|
||||||
|
|
||||||
|
# Testing & Debugging
|
||||||
|
|
||||||
|
Debugging tools, test cases, and best practices for troubleshooting.
|
4
webpage/docs/hardware-acceleration/_category_.json
Normal file
4
webpage/docs/hardware-acceleration/_category_.json
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"position": 3,
|
||||||
|
"label": "Hardware Acceleration"
|
||||||
|
}
|
7
webpage/docs/hardware-acceleration/amd-gpu-support.md
Normal file
7
webpage/docs/hardware-acceleration/amd-gpu-support.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# AMD GPU Support
|
||||||
|
|
||||||
|
Configuring VA-API for AMD GPUs and optimizing performance.
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# GPU Acceleration Overview
|
||||||
|
|
||||||
|
Benefits of hardware acceleration and when to use it.
|
7
webpage/docs/hardware-acceleration/intel-qsv.md
Normal file
7
webpage/docs/hardware-acceleration/intel-qsv.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 4
|
||||||
|
---
|
||||||
|
|
||||||
|
# Intel Quick Sync (QSV)
|
||||||
|
|
||||||
|
How to enable Quick Sync Video for Intel-based encoding.
|
7
webpage/docs/hardware-acceleration/nvidia-gpu-support.md
Normal file
7
webpage/docs/hardware-acceleration/nvidia-gpu-support.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# NVIDIA GPU Support
|
||||||
|
|
||||||
|
Using CUDA/NVENC for hardware encoding in Docker and native installations.
|
7
webpage/docs/hardware-acceleration/raspberry-pi.md
Normal file
7
webpage/docs/hardware-acceleration/raspberry-pi.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 5
|
||||||
|
---
|
||||||
|
|
||||||
|
# Raspberry Pi GPU Acceleration
|
||||||
|
|
||||||
|
Enabling hardware acceleration on Raspberry Pi with VideoCore.
|
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"position": 8,
|
||||||
|
"label": "Integration & Extensibility"
|
||||||
|
}
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Automating with Webhooks
|
||||||
|
|
||||||
|
Using webhooks to trigger actions in response to Neko events.
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Custom Configurations
|
||||||
|
|
||||||
|
Advanced settings and custom scripts for extending Neko’s functionality.
|
|
@ -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.
|
4
webpage/docs/user-guide/_category_.json
Normal file
4
webpage/docs/user-guide/_category_.json
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"position": 2,
|
||||||
|
"label": "User Guide"
|
||||||
|
}
|
7
webpage/docs/user-guide/authentication-and-roles.md
Normal file
7
webpage/docs/user-guide/authentication-and-roles.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Authentication & User Roles
|
||||||
|
|
||||||
|
Configuring authentication, user roles, and access permissions.
|
7
webpage/docs/user-guide/connecting-and-using-neko.md
Normal file
7
webpage/docs/user-guide/connecting-and-using-neko.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# Connecting & Using Neko
|
||||||
|
|
||||||
|
How users can connect to a Neko session and interact with it.
|
7
webpage/docs/user-guide/managing-sessions.md
Normal file
7
webpage/docs/user-guide/managing-sessions.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Managing Sessions
|
||||||
|
|
||||||
|
Guide to starting, stopping, and managing Neko sessions.
|
7
webpage/docs/user-guide/performance-tuning.md
Normal file
7
webpage/docs/user-guide/performance-tuning.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 4
|
||||||
|
---
|
||||||
|
|
||||||
|
# Performance Tuning
|
||||||
|
|
||||||
|
Optimizing video quality, latency, and encoding settings (Low Latency, Encoding, etc.).
|
7
webpage/docs/user-guide/security-best-practices.md
Normal file
7
webpage/docs/user-guide/security-best-practices.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 5
|
||||||
|
---
|
||||||
|
|
||||||
|
# Security Best Practices
|
||||||
|
|
||||||
|
Tips for securing a Neko deployment, including encryption and firewall settings.
|
Loading…
Add table
Reference in a new issue