Refresh the docs: one architecture page, delete stale notes

Abierto Apto para principiantes
#12 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
markdown, rust, swift

Línea de trabajo

Empieza con los dos archivos obsoletos mencionados en la issue, COREML_IMPLEMENTATION.md y research/session-summary.md, y compáralos con el README y las fuentes actuales de Rust y Swift para averiguar qué hacen realmente el bridge y los pipelines de fotos y vídeo. Escribe un docs/architecture.md que describa esas partes y también dónde se realizan el refinamiento de profundidad y el relleno de huecos; luego mueve o elimina los archivos obsoletos con un encabezado fechado y un enlace a la nueva página desde el README. El trabajo estará terminado cuando estén marcadas las tres casillas de aceptación de la issue.

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

Descripción

COREML_IMPLEMENTATION.md and research/session-summary.md describe an earlier ONNX-first design and early timings. They contradict the current code and README.

Acceptance criteria

  • A single docs/architecture.md covering the Rust to Swift bridge, the photo and video pipelines, and where depth refinement and hole filling happen, matching the code
  • Stale files removed or moved under docs/history/ with a dated header
  • README links to the architecture page

Estimate: 3 h

Lenguaje dominante
Rust
Estrellas
0
Forks
0
Merge medio
3 min
PR fusionados (30 d)
3

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 mrgnw/spatial-maker

Todos los issues de mrgnw/spatial-maker

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.