Skip to content

docs(sample): clarify the README quickstart, project layout and UC1 wording - #85

Merged
zhangwenjun-huawei merged 3 commits into
project-openan:mainfrom
codetalks-hw:docs/ran-energy-saving-uc1-wording
Oct 20, 2026
Merged

zhangwenjun-huawei merged 3 commits into
project-openan:mainfrom
codetalks-hw:docs/ran-energy-saving-uc1-wording

Conversation

@codetalks-hw

@codetalks-hw codetalks-hw commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Documentation follow-ups in the ran-energy-saving README (en/zh).

Quickstart

  • Three labelled steps: Step 1 create the repository .venv, Step 2 configure the sample, Step 3 run the sample.
  • The step descriptions live in the prose; the command blocks now contain only commands.
  • The Windows interpreter path is a separate tip.
  • The output sentence now reads: "Both client and server logs stream to the terminal live and interleaved, with background processes automatically terminating when the client exits."

Project layout (§1.1)

  • server_main.py: the A2A SDK app assembly includes the push-notification module by default; server-side integration points to the INTEGRATION POINT comment in build_server_runtime.
  • scenario_data.py: the "not removable until both sides are replaced" clause is removed.
  • task_execution.py: describes the TaskExecutionService execution entry point plus the demo service that simulates progress and generates intent reports.
  • run_demo.py: simplified to the non-blocking launcher behavior (the cross-platform claim is dropped).

UC1 wording

The README used the undefined abbreviation UC1; both rows now describe the demo execution and its scripted progress/report data directly. Code comments keep UC1 where the RAN interface specification is already named.

Docs-only; no behavior change.

Signed-off-by: codetalks-hw <lihaizhen5@huawei.com>
@codetalks-hw
codetalks-hw requested a review from a team as a code owner October 20, 2026 06:54
Signed-off-by: codetalks-hw <lihaizhen5@huawei.com>
@codetalks-hw codetalks-hw changed the title docs(sample): spell out the demo execution instead of UC1 docs(sample): clarify the quickstart steps and the UC1 wording Oct 20, 2026
Signed-off-by: codetalks-hw <lihaizhen5@huawei.com>
@codetalks-hw codetalks-hw changed the title docs(sample): clarify the quickstart steps and the UC1 wording docs(sample): clarify the README quickstart, project layout and UC1 wording Oct 20, 2026
@zhangwenjun-huawei
zhangwenjun-huawei merged commit f017b44 into project-openan:main Oct 20, 2026
5 checks passed
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.

2 participants