docs(core): READMEs and TSDoc examples use removed APIs

Abierto Apto para principiantes
  • ¿Algo no está bien?
#508 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
typescript
Área
documentation

Línea de trabajo

Lee los ejemplos de packages/core/README.md, packages/asset/README.md y modules/ecs/README.md y compáralos con las API actuales de packages/core/src/application/nanoforge-application.ts y nanoforge-client.ts. Actualiza los fragmentos para que usen los nombres y patrones indicados en el issue, elimina el ejemplo obsoleto de asset-manager y sigue la regla de las funciones flecha. La tarea estará completa cuando los ejemplos usen las API actuales y ya no muestren los nombres eliminados.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation modules:ecs packages:asset packages:core
What is the type of issue?

Documentation is incorrect, Example code is not working

What is the issue?

The examples use IRunOptions / IRunClientOptions (renamed to RunOptions / ClientRunOptions), @nanoforge-dev/asset-manager and app.useAssetManager (assets are now on ctx.assets), useGraphics(...), and __RESERVED_entityId (getIndexedZipper returns id). None of these names exist in src. They also use export async function, against the arrow-function rule.

Evidence:

import { type IRunOptions } from "@nanoforge-dev/common";
app.useAssetManager(assetManager);
for (const { __RESERVED_entityId, Position } of registry.getZipper([

Suggested fix: Rewrite the snippets against the current API (ClientRunOptions, app.use(...), getIndexedZipper([Position]) with id) and remove the asset-manager snippet.

Found during a code audit of main at be72076.

Where did you find it?
Lenguaje dominante
TypeScript
Estrellas
7
Forks
2
Merge medio
1 d 17 h
PR fusionados (30 d)
17

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NanoForge-dev/Engine

Todos los issues de NanoForge-dev/Engine

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.