Synchronise docs with haxe manual

Abierto
#1,452 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
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
cpp

Línea de trabajo

The source of truth is the docs directory in this repo, and the duplicate copy lives in the HaxeManual repo at content/12-target-details.md, under the hxcpp section. Start by comparing the two to see which pages have drifted and what format the manual expects. Done would be a repeatable way to regenerate the manual's section from docs, or a documented decision on how the two stay in sync. The issue leaves the mechanism open, so confirm the approach with maintainers before writing a script.

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

Descripción

There is a copy of the hxcpp docs in the haxe manual: https://github.com/HaxeFoundation/HaxeManual/blob/master/content/12-target-details.md#c

It is out of sync with the contents of docs in this repo, which leads to duplicated work: https://github.com/HaxeFoundation/hxcpp/pull/1166#issuecomment-2538892090. It would be good to have some mechanism to keep them in sync, perhaps a script that can merge the docs in this repo and put them in the format the manual expects. This repo seems to make sense as the main authority.

Lenguaje dominante
C++
Estrellas
330
Forks
233
Merge medio
7 h 13 min
PR fusionados (30 d)
17

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 HaxeFoundation/hxcpp

Todos los issues de HaxeFoundation/hxcpp

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.