[GSoC2026} Project #5: Improve Getting Started Documentation

[MonicaH2025]

Hi, There,

I'm a beginner of open source area. I found DORA project and I'm very interested at Project #5: Improve Getting Started Documentation.
I feel it's quite a very good starting point of learning DORA technology.

For Project #5, I'm asking any specific requirements, like wording style, doc format, or video requirements for this improvement work.

I appreciate if any guidelines could be offered.

looking forward to your response!

Monica

[eraser3721]

Hi, Monica,

Thank you for your interest in the project and welcome to the open-source community!
We’re excited to support you as a beginner, and below are the specific guidelines, requirements, and best practices for this project:

1. Wording Style Requirements
   The core goal of the "Getting Started" docs is to be beginner-friendly, clear, and concise (aligned with DORA’s existing documentation tone, e.g., CONTRIBUTING.md, examples/*/README.md):

• Terminology: Define key DORA concepts (e.g., dataflow, operator, node, DoraNode) simply when first mentioned—avoid overloading beginners with jargon.
• Tone: Practical and action-oriented (focus on "how to do X" rather than abstract explanations).
• Consistency: Match the style of existing DORA docs (e.g., short paragraphs, active voice, no overly technical language unless accompanied by examples).
• Clarity: For command-line steps/ code snippets, add brief comments to explain why a step is needed (not just what to do).

2. Document Format Requirements
   DORA’s entire documentation ecosystem uses Markdown (MD)—please adhere to this standard, with additional structural rules:

• Hierarchy: Use consistent heading levels (follow DORA’s existing pattern):
  -- # for the main title (e.g., "Getting Started with DORA")
  -- ## for major sections (e.g., "Install DORA", "Run Your First Dataflow")
  -- ### for subsections (e.g., "Install DORA for Python", "Configure VSCode for YAML Dataflows")
• Code Blocks:
  Always specify the language (e.g., bash, python, rust, c++) for syntax highlighting (matching examples in binaries/cli/src/template/ or examples/).
  Ensure all code snippets are runnable (test against DORA’s main branch to avoid broken examples).
• Structure: A minimal "Getting Started" doc should include:
  Prerequisites (e.g., Rust/Python/UV installation)
  Step-by-step installation (simplified for beginners)
  1–2 "hello world" examples (prioritize Python first—more beginner-friendly, then Rust/C/C++)
  FAQ/Troubleshooting (address common beginner issues: e.g., "pip install dora-rs fails", "dora run dataflow.yml errors")
• References: Link to existing DORA resources (e.g., VSCode YAML schema setup in libraries/core/README.md, example dataflows in examples/) to avoid duplication.

3. Video Requirements (If Included)
   If you plan to create video tutorials (optional but highly welcome for beginners):

• Focus: Keep videos short (5–10 minutes) and focused on core "getting started" workflows:
  Environment setup (install Rust/Python/UV + DORA)
  Create a minimal YAML dataflow
  Run the dataflow and verify output
  Customize a simple node/operator
• Quality: Clear screen recording (command-line text must be readable), slow/clear narration, and English subtitles (for accessibility).
• Sync with Docs: All steps/commands in videos must be fully documented in the Markdown guide (so users can follow without watching the video).

Hope it helps！

The Team

[eraser3721]

Any further questions, please let us know.

[khanhtuanvo]

@eraser3721

Hi, I'm currently contributing to the adora codebase (PRs fixing build errors and adding example READMEs) and planning to apply for Project #5. Your guidelines are very helpful. I have a few clarifying questions before finalizing my proposal:

1. For the 175-hour scope, what is the priority order among Python quickstart, Rust quickstart, C/C++ guides, video tutorials, and FAQ/troubleshooting?
2. Are video tutorials part of the evaluation criteria or a bonus?
3. What are the top 1–2 points where new users get stuck that aren't currently covered well?
4. Should new guide pages also include Chinese translations (po/zh-CN.po), or is that out of scope?

[eraser3721]

@khanhtuanvo

Thanks for your good questions!

1. Python quickstart, Rust quickstart, C/C++ guides are top priorities.
2. In terms of video tutorials, NICE to have.
3. Can't answer right now, yeah, it's an excellent point.
4. NICE to have, not mandatory.

The Team

[khanhtuanvo]

@eraser3721

Hi, I noticed that there are changes in https://github.com/dora-rs/dora/wiki/GSoC_2026 docs. I found that the repo links were changed from adora to dora. For this project, which one should I contribute instead. I'm confusing since I have been contributing to adora but now it switch to the dora repo. Also, what about dorahub repo?