Skip to content

[WAYANG-613] Improve documentation structure, abstractions, and deep learning guide - #802

Open
AliRana30 wants to merge 1 commit into
apache:mainfrom
AliRana30:docs/improve-documentation-613
Open

[WAYANG-613] Improve documentation structure, abstractions, and deep learning guide#802
AliRana30 wants to merge 1 commit into
apache:mainfrom
AliRana30:docs/improve-documentation-613

Conversation

@AliRana30

@AliRana30 AliRana30 commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Description

  • Reorganized Getting Started: Moved system requirements into "How to Build", and relocated configuration settings and cost functions to dedicated pages under using_wayang/.
  • Added Abstractions & Plan Construction Guide: Documented the 5 core operator types (Source, Unary, Binary, Loop, Sink) and added an overview of PlanBuilder.
  • Added Scalable Deep Learning Guide: Documented DLModel, DLTrainingOperator, PredictOperator, and TensorFlow platform integration.
  • Enabled Menus & Linked JavaDocs: Activated site navigation and added direct links to the official API JavaDocs.

Closes #613


Screenshots

1. Home Page (Streamlined Navigation)

image

2. How to Build & Requirements

image

3. Core Operator Abstractions & PlanBuilder

image

4. Configuring Wayang & Cost Model Calibration

image

5. Scalable Deep Learning Guide

image

Copilot AI lite review requested due to automatic review settings September 2, 2026 21:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

There are documentation correctness issues (misleading Maven Central vs -SNAPSHOT guidance and likely-broken .md internal links) that should be fixed before merging.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR restructures the Wayang documentation site navigation and expands the “Getting Started” and “Using Wayang” sections with dedicated pages for configuration, cost model calibration, core abstractions/plan construction, and scalable deep learning, aligning with the suggestions in #613.

Changes:

  • Reorganized landing pages and navigation (header menus + section menus) to better separate build, plan construction, configuration, and advanced topics.
  • Added new user guides under using_wayang/ for configuration and scalable deep learning; expanded cost model calibration documentation.
  • Added/updated cross-links between sections and linked to the official API JavaDocs.
File summaries
File Description
wayang-docs/src/main/resources/using_wayang/scalable_deep_learning.md Adds a new deep learning guide and TensorFlow module usage overview.
wayang-docs/src/main/resources/using_wayang/index.md Updates “Using Wayang” landing page structure and links to guides + JavaDocs.
wayang-docs/src/main/resources/using_wayang/cost_model_calibration.md Expands and repositions cost model calibration documentation within “Using Wayang”.
wayang-docs/src/main/resources/using_wayang/configuring_wayang.md Adds a new configuration reference page and links into calibration docs.
wayang-docs/src/main/resources/index.md Streamlines the site home page and adds quick navigation + updated dependency guidance.
wayang-docs/src/main/resources/getting_start/writting_wayang_plan/index.md Renames/expands the plan-writing page with operator abstractions + PlanBuilder overview.
wayang-docs/src/main/resources/getting_start/index.md Reworks “Getting Started” landing page into a structured section index + JavaDocs link.
wayang-docs/src/main/resources/getting_start/how_build/index.md Expands build requirements and adds build profile overview + step-by-step link.
wayang-docs/src/main/resources/getting_start/how_build/build_step.md Expands step-by-step build instructions and adds navigation metadata.
wayang-docs/src/main/resources/_data/menus.yml Enables header/section menus and adds entries for new/renamed pages and JavaDocs.
Review details

Suppressed comments (2)

wayang-docs/src/main/resources/using_wayang/scalable_deep_learning.md:62

  • Hardcoding a -SNAPSHOT version in docs tends to cause copy/paste failures unless the snapshot repository is configured; prefer a WAYANG_VERSION placeholder (or a released version).
  <version>1.1.2-SNAPSHOT</version>

wayang-docs/src/main/resources/index.md:83

  • The dependency snippet hardcodes a -SNAPSHOT version, which generally won't resolve from Maven Central; use a version placeholder (or a released version) so readers can copy/paste successfully.
<dependency>
  <groupId>org.apache.wayang</groupId>
  <artifactId>wayang-core</artifactId>
  <version>1.1.2-SNAPSHOT</version>
</dependency>
<dependency>
  <groupId>org.apache.wayang</groupId>
  <artifactId>wayang-basic</artifactId>
  <version>1.1.2-SNAPSHOT</version>
</dependency>
<dependency>
  <groupId>org.apache.wayang</groupId>
  <artifactId>wayang-api-scala-java</artifactId>
  <version>1.1.2-SNAPSHOT</version>
</dependency>
  • Files reviewed: 10/10 changed files
  • Comments generated: 5
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread wayang-docs/src/main/resources/getting_start/how_build/index.md Outdated
Comment thread wayang-docs/src/main/resources/index.md
Comment thread wayang-docs/src/main/resources/using_wayang/configuring_wayang.md Outdated
@AliRana30

Copy link
Copy Markdown
Contributor Author

@paulk-asert and @novatechflow needed your review.

Comment thread wayang-docs/src/main/resources/getting_start/index.md Outdated
Comment thread wayang-docs/src/main/resources/getting_start/how_build/build_step.md Outdated
Comment thread wayang-docs/src/main/resources/getting_start/how_build/index.md Outdated
Comment thread wayang-docs/src/main/resources/index.md Outdated
Comment thread wayang-docs/src/main/resources/index.md Outdated
Comment thread wayang-docs/src/main/resources/index.md
@AliRana30
AliRana30 force-pushed the docs/improve-documentation-613 branch from 2275c25 to af876b3 Compare September 4, 2026 12:32
@AliRana30

Copy link
Copy Markdown
Contributor Author

Thanks for the review @zkaoudi! I have addressed all your comments: removed '(incubating)' and GraphChi, updated system requirements strictly to Java 17, and updated platform versions and added the newer supported platforms (Trino, Presto, BigQuery, TensorFlow, Generic JDBC, Giraph)."

@AliRana30
AliRana30 requested a review from zkaoudi September 4, 2026 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Suggested improvements to documentation

3 participants