Documentation Revamp / Organisation

Bắt đầu bằng việc đọc issue liên quan #1204 và lập sơ đồ cách processing-website, processing-doclet, processing-examples, processing4 và processing4-javadocs hiện đang trao đổi nội dung được tạo. Xem xét các bước build và release hiện có trước khi chọn hướng di chuyển. Được xem là hoàn tất khi các repository không còn yêu cầu đặt thủ công cùng một vị trí hoặc các bản sao chỉ đọc, và các thao tác tạo và cập nhật được ghi chép đã được tự động hóa hoặc hợp nhất.

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

• processing-website
  • updates processing4's keywords.txt based on content generated through processing-doclet
  • has to manually update content/examples and it is unclear that this data is partially read-only, the script applies processing-examples on top
  • content/contributions is also readonly and is no longer compatible with the new processing-contributions pipeline
• processing4-javadocs does not automatically update with each release
• processing-examples does not contain the images/livesketches/metadata that the website needs.
• processing-doclet is a separate repo that will create the parsed javadoc comments for the website

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