Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .github/workflows/api_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: API Documentation

on:
push:
branches: [main, develop]
paths:
- 'lib/PixelRoot32-Game-Engine/docs/API_REFERENCE.md'
workflow_dispatch:

jobs:
sync-api-docs:
runs-on: ubuntu-latest

steps:
- name: Checkout Docs
uses: actions/checkout@v4
with:
path: docs

- name: Checkout Engine
uses: actions/checkout@v4
with:
repository: PixelRoot32-Game-Engine/PixelRoot32-Game-Engine
path: engine
sparse-checkout: |
lib/PixelRoot32-Game-Engine/docs
sparse-checkout-cone-mode: false

- name: Sync API Reference
run: |
cp engine/lib/PixelRoot32-Game-Engine/docs/API_REFERENCE.md docs/docs/api_reference/index.md

- name: Commit and Push
run: |
cd docs
git config --local user.email "docs@pixelroot32.org"
git config --local user.name "PixelRoot32 Bot"
git add docs/api_reference/index.md
git diff --staged --quiet || git commit -m "docs: sync API reference from engine"
git push
46 changes: 46 additions & 0 deletions .github/workflows/deploy_preview.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Deploy Preview

on:
pull_request:
branches: [main, develop]

jobs:
deploy-preview:
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'

permissions:
contents: write

steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.ref }}

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install dependencies
run: |
pip install mkdocs-material mike mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin

- name: Build docs
run: |
mkdocs build

- name: Deploy preview
if: env.NETLIFY_AUTH_TOKEN != ''
uses: nwtgck/actions-netlify@v2.0
with:
publish-dir: ./site
github-token: ${{ secrets.GITHUB_TOKEN }}
deploy-message: "Deploy preview for PR #${{ github.event.pull_request.number }}"
enable-pull-request-comment: false
enable-commit-comment: false
overwrites-pull-request-comment: false
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
4 changes: 2 additions & 2 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ jobs:
pip install mkdocs-git-revision-date-localized-plugin
pip install mike

- name: Build documentation (strict)
run: mkdocs build --strict || mkdocs build
- name: Build documentation
run: mkdocs build

- name: Upload Pages artifact
if: github.ref == 'refs/heads/main'
Expand Down
40 changes: 40 additions & 0 deletions .github/workflows/link_check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Link Checker

on:
pull_request:
paths:
- 'docs/**/*.md'
push:
branches: [main, develop]
workflow_dispatch:

jobs:
check-links:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install dependencies
run: |
pip install mkdocs-material

- name: Build docs
run: |
mkdocs build 2>&1 | tee build.log

- name: Check for link warnings
run: |
if grep -q "WARNING.*link" docs/build.log; then
echo "⚠️ Link warnings found in build"
grep "WARNING.*link" docs/build.log || true
exit 1
else
echo "✅ No broken internal links found"
fi
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# Site output
site/

# Agents
.opencode/
29 changes: 29 additions & 0 deletions docs/404.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Page Not Found
template: 404.html
hide:
- navigation
- toc
- footer
---

# Page Not Found

The page you're looking for doesn't exist or has been moved.

## Quick Links

- [Home](.)
- [Getting Started](getting_started/)
- [Hardware](hardware/)
- [API Reference](api_reference/)
- [Tools](tools/)

## Search

Use the search bar above to find what you're looking for.

## Need Help?

- Check the [Troubleshooting](resources/troubleshooting.md) guide
- Visit our [Discord community](https://discord.gg/QVp7qdHScR)
21 changes: 21 additions & 0 deletions docs/_redirects
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Redirects for old URLs
# Format: /old-path /new-path 301

# Hardware redirects
/getting_started/installation.html /hardware/esp32/setup_guide 301
/getting_started/installation /hardware/esp32/setup_guide 301

# Manual redirects
/manual/physics/overview.html /manual/physics/ 301
/manual/physics/overview /manual/physics/ 301
/manual/game_development/ /manual/ 301

# Reference redirects
/reference/api_overview.html /api_reference/ 301
/reference/api_overview /api_reference/ 301

# Tools redirects
/tools/tilemap_editor/overview.html /tools/tilemap_editor/overview 301

# Examples redirects
/examples/ /examples/index.html 301
20 changes: 20 additions & 0 deletions docs/api_reference/audio/abstracts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: abstracts Class
description: abstracts class in PixelRoot32
tags: [api, class, abstracts]
---

# abstracts

## Métodos

| Return | Name | Parameters |
|--------|------|------------|
| `void` | `init` | `AudioEngine* engine, const pixelroot32::platforms::PlatformCapabilities& caps = pixelroot32::platforms::PlatformCapabilities(` |
| `int` | `getSampleRate` | `-` |

## Descripción

Located in: `AudioBackend.h`

Namespace: `pixelroot32::audio`
22 changes: 22 additions & 0 deletions docs/api_reference/audio/audiobackend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: AudioBackend Class
description: AudioBackend
tags: [api, class, audiobackend]
---

# AudioBackend

> **AudioBackend**

## Métodos

| Return | Name | Parameters |
|--------|------|------------|
| `void` | `init` | `AudioEngine* engine, const pixelroot32::platforms::PlatformCapabilities& caps = pixelroot32::platforms::PlatformCapabilities(` |
| `int` | `getSampleRate` | `-` |

## Descripción

Located in: `AudioBackend.h`

Namespace: `pixelroot32::audio`
14 changes: 14 additions & 0 deletions docs/api_reference/audio/audiochannel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: AudioChannel Struct
description: AudioChannel
tags: [api, struct, audiochannel]
---

# AudioChannel

> **AudioChannel**


## Descripción

Located in: `AudioTypes.h`
14 changes: 14 additions & 0 deletions docs/api_reference/audio/audiocommand.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: AudioCommand Struct
description: AudioCommand
tags: [api, struct, audiocommand]
---

# AudioCommand

> **AudioCommand**


## Descripción

Located in: `AudioTypes.h`
16 changes: 16 additions & 0 deletions docs/api_reference/audio/audiocommandqueue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: AudioCommandQueue Class
description: AudioCommandQueue
tags: [api, class, audiocommandqueue]
---

# AudioCommandQueue

> **AudioCommandQueue**


## Descripción

Located in: `AudioCommandQueue.h`

Namespace: `pixelroot32::audio`
16 changes: 16 additions & 0 deletions docs/api_reference/audio/audiocommandtype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: AudioCommandType Class
description: AudioEvent
tags: [api, class, audiocommandtype]
---

# AudioCommandType

> **AudioEvent**


## Descripción

Located in: `AudioTypes.h`

Namespace: `pixelroot32::audio`
14 changes: 14 additions & 0 deletions docs/api_reference/audio/audioconfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: AudioConfig Struct
description: AudioConfig
tags: [api, struct, audioconfig]
---

# AudioConfig

> **AudioConfig**


## Descripción

Located in: `AudioConfig.h`
27 changes: 27 additions & 0 deletions docs/api_reference/audio/audioengine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: AudioEngine Class
description: AudioEngine
tags: [api, class, audioengine]
---

# AudioEngine

> **AudioEngine**

## Métodos

| Return | Name | Parameters |
|--------|------|------------|
| `void` | `init` | `-` |
| `void` | `generateSamples` | `int16_t* stream, int length` |
| `void` | `playEvent` | `const AudioEvent& event` |
| `void` | `setMasterVolume` | `float volume` |
| `float` | `getMasterVolume` | `-` |
| `void` | `submitCommand` | `const AudioCommand& cmd` |
| `void` | `setScheduler` | `std::unique_ptr<AudioScheduler> scheduler` |

## Descripción

Located in: `AudioEngine.h`

Namespace: `pixelroot32::audio`
21 changes: 21 additions & 0 deletions docs/api_reference/audio/audioevent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: AudioEvent Struct
description: AudioEvent
tags: [api, struct, audioevent]
---

# AudioEvent

> **AudioEvent**

## Miembros

| Type | Name |
|------|------|
| `float` | `duration` |
| `float` | `volume` |
| `float` | `duty` |

## Descripción

Located in: `AudioTypes.h`
26 changes: 26 additions & 0 deletions docs/api_reference/audio/audioscheduler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: AudioScheduler Class
description: AudioScheduler
tags: [api, class, audioscheduler]
---

# AudioScheduler

> **AudioScheduler**

## Métodos

| Return | Name | Parameters |
|--------|------|------------|
| `void` | `init` | `AudioBackend* backend, int sampleRate, const pixelroot32::platforms::PlatformCapabilities& caps = pixelroot32::platforms::PlatformCapabilities(` |
| `void` | `submitCommand` | `const AudioCommand& cmd` |
| `void` | `start` | `-` |
| `void` | `stop` | `-` |
| `bool` | `isIndependent` | `-` |
| `void` | `generateSamples` | `int16_t* stream, int length` |

## Descripción

Located in: `AudioScheduler.h`

Namespace: `pixelroot32::audio`
Loading
Loading