processing / processing/processing-website

Core reference and Libraries reference entries share the same template

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

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

主要言語
MDX
スター
90
フォーク
122
平均マージ
1時間 43分
マージ済み PR(30日)
3

説明

Because there's a single template to build all of the reference pages, the Library reference pages have the wrong left-nav option selected (Reference and not Libraries). Also, they can't have a custom message at the top of the page about the Javadoc. I think this requires digging into java-generate and rebuilding the Java classes.

In addition, the non-core Libraries from the Processing Foundation (Video and Sound) can't have a separate header message. They link to the Libraries Javadoc, but the code isn't there. Thinking about this more, we could probably build those Javadocs and add them while the rest are built.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

調査の方向性

まず、共有されているリファレンスページのテンプレートと、issue で言及されている java-generate エントリーポイントを調べ、続いて Java クラスがどのように再構築されるかを追跡します。完了の条件は、Library ページで左側のナビゲーションの Libraries が選択され、カスタム Javadoc メッセージがサポートされ、Video ページと Sound ページで Javadoc リンクまたは生成された Javadocs が意図どおりに処理されることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
documentation
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

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

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