processing / processing/processing-website
Adding "Go to source" link to reference pages
まだ誰も着手していません。
- 主要言語
- MDX
- スター
- 90
- フォーク
- 122
- 平均マージ
- 1時間 43分
- マージ済み PR(30日)
- 3
説明
Which area of the website does this enhancement relate to?
Reference
Describe the enhancement
Reference pages don't have any reference, connecting them to their source version in this repo. Let's say you want update a reference page, or simply fix a typo: https://processing.org/reference/frameCount.html While the change is only a single letter, because the website has no reference to https://github.com/processing/processing-website/blob/1fce63d07182becca614b95ab76b3b1416424d8d/content/references/translations/en/processing/frameCount.json , one should learn where the content is kept and search for the content in the repo.
Why is this enhancement important?
The lack of direct connection the presentation and source layer for reference docs makes the contribution process harder.
Additional context
No response
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
frameCount のリファレンスページと、それに対応する content/references/translations/en/processing/frameCount.json ファイルから始めます。リファレンスページがどのように表示されているかをたどり、次にソースへのリンクをどこに配置すべきかを判断します。リファレンスページからこのリポジトリ内のソースコンテンツへの直接リンクが提供されれば、作業は完了です。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 活発
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 72/100