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 摘要。