Synchronise docs with haxe manual

未关闭
  • 哪里不对？
#1,452 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
cpp
领域
documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
C++
星标
330
派生
233
平均合并
10 小时 49 分钟
30 天内合并 PR
19

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

HaxeFoundation/hxcpp 的其他 Issue

查看 HaxeFoundation/hxcpp 的全部 Issue

相似的 Issue

更多 C++ Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。