Hacktoberfest 2026:維護者為十月標記出來的 issue,仍然開放、適合新手。 瀏覽 Hacktoberfest issue

Documentation Revamp / Organisation

未關閉
#1,350 6 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
20/100
Issue 類型
重構
描述清晰度
需要釐清
活躍度
停滯
技術堆疊
java

研究方向

先閱讀相關 issue #1204,並整理 processing-website、processing-doclet、processing-examples、processing4 和 processing4-javadocs 目前如何交換產生的內容。在選擇移轉路徑前,檢視現有的 build 和 release 步驟。完成的定義是:各 repository 不再需要手動將內容放在同一位置或維護唯讀副本,且文件化的產生與更新操作已自動化或整合。

由索引模型根據 Issue 內容生成。

描述

documentation

The examples and some of the documentation around Processing are kind of all over the place

The Goal

Have one repo where documentation lives: processing-website

The current issues
Suggested actions
  • Get rid of any instances where the developer has to make sure repositories live next to each other on disk
  • Migrate processing-doclet into the processing-website and make it run on build
    • Research further into migrating / replicating the custom doclet into Gradle and make it run w gradle
  • Delete processing-doclet repo
  • Migrate processing-examples into the processing-website
    • Tested, still need to figure out how to merge the folders whilst keeping history
  • Archive processing-examples
  • Remove all read-only files from processing-website
  • Move the generation of keywords.txt back into the processing4 repo
  • Add an automatic update trigger for processing4-javadoc to the processing4 repo release action (or migrate processing4-javadoc into the processing4 repo)
    • Migrate Javadoc from Ant to Gradle
Related PRs/Issues/Other documentation

#1204

主要語言
Java
星號
497
分支
183
平均合併
4 小時 39 分鐘
30 天內合併 PR
3

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

processing/processing4 的其他 Issue

查看 processing/processing4 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。