Synchronise docs with haxe manual

オープン
#1,452 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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
平均マージ
7時間 13分
マージ済み PR(30日)
17

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

HaxeFoundation/hxcpp のほかの issue

HaxeFoundation/hxcpp の issue をすべて見る

似ている issue

C++ の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。