[WAYANG-613] Improve documentation structure, abstractions, and deep learning guide - #802
[WAYANG-613] Improve documentation structure, abstractions, and deep learning guide#802AliRana30 wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
🟡 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
-SNAPSHOTversion in docs tends to cause copy/paste failures unless the snapshot repository is configured; prefer aWAYANG_VERSIONplaceholder (or a released version).
<version>1.1.2-SNAPSHOT</version>
wayang-docs/src/main/resources/index.md:83
- The dependency snippet hardcodes a
-SNAPSHOTversion, 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.
|
@paulk-asert and @novatechflow needed your review. |
2275c25 to
af876b3
Compare
|
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)." |
Description
using_wayang/.PlanBuilder.DLModel,DLTrainingOperator,PredictOperator, and TensorFlow platform integration.Closes #613
Screenshots
1. Home Page (Streamlined Navigation)
2. How to Build & Requirements
3. Core Operator Abstractions & PlanBuilder
4. Configuring Wayang & Cost Model Calibration
5. Scalable Deep Learning Guide