Skip to content

Update documentation, enhance README, and version bump to 0.3.0#14

Merged
FrozenLemonTee merged 17 commits intomainfrom
pre-0.3.0
Mar 22, 2026
Merged

Update documentation, enhance README, and version bump to 0.3.0#14
FrozenLemonTee merged 17 commits intomainfrom
pre-0.3.0

Conversation

@FrozenLemonTee
Copy link
Member

No description provided.

Signed-off-by: FrozenlemonTee <1115306170@qq.com>
…ions in ex02_type_policy

Signed-off-by: FrozenlemonTee <1115306170@qq.com>
…e/underlying operations

Signed-off-by: FrozenlemonTee <1115306170@qq.com>
…ite workload

Signed-off-by: FrozenlemonTee <1115306170@qq.com>
…d usage examples

Signed-off-by: FrozenlemonTee <1115306170@qq.com>
…ty and navigation

Signed-off-by: FrozenlemonTee <1115306170@qq.com>
Signed-off-by: FrozenlemonTee <1115306170@qq.com>
Signed-off-by: FrozenlemonTee <1115306170@qq.com>
Signed-off-by: FrozenlemonTee <1115306170@qq.com>
…cumentation

Signed-off-by: FrozenlemonTee <1115306170@qq.com>
…documentation links

Signed-off-by: FrozenlemonTee <1115306170@qq.com>
…o the root

Signed-off-by: FrozenlemonTee <1115306170@qq.com>
Signed-off-by: FrozenlemonTee <1115306170@qq.com>
Signed-off-by: FrozenlemonTee <1115306170@qq.com>
Signed-off-by: FrozenlemonTee <1115306170@qq.com>
Signed-off-by: FrozenlemonTee <1115306170@qq.com>
Copilot AI review requested due to automatic review settings March 22, 2026 13:33
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR focuses on a documentation overhaul (new bilingual user guide + API docs), updates project READMEs accordingly, refreshes a few examples to match the newer behaviors being documented, and bumps the project version to 0.3.0.

Changes:

  • Bump project version to 0.3.0 in both xmake and CMake.
  • Add structured documentation under docs/ (Guide + API, English + Chinese) and update root READMEs.
  • Update examples to demonstrate mixed primitive/underlying operations and a more realistic fenced-concurrency workload.

Reviewed changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 15 comments.

Show a summary per file
File Description
xmake.lua Add project metadata (name/version) for xmake builds.
CMakeLists.txt Bump CMake project version to 0.3.0.
examples/ex02_type_policy.cpp Expand type-policy example to cover cross-underlying construction behavior.
examples/ex03_value_policy.cpp Extend value-policy example to cover primitive/underlying mixed ops.
examples/ex05_concurrency_policy.cpp Replace simple concurrency demo with mixed read/write workload + CAS check.
docs/guide/README.md Add guide entry point.
docs/guide/en/* New English guide pages (install, quick start, concurrency, extension).
docs/guide/zh/* New Chinese guide pages (install, quick start, concurrency, extension).
docs/api/README.md Add API docs entry point.
docs/api/en/README.md New English API overview/reference.
docs/api/zh/README.md New Chinese API overview/reference.
docs/README.md Add docs root index linking Guide + API.
README.md Refresh English README to match new docs and capabilities.
README.zh.md Add Chinese README matching new docs and capabilities.
LICENSE Fill in Apache 2.0 appendix boilerplate copyright line.
.github/prompts/plan-policyBehaviorProtocol.prompt.md Remove an obsolete planning prompt document.

Signed-off-by: FrozenlemonTee <1115306170@qq.com>
@FrozenLemonTee FrozenLemonTee merged commit 4166133 into main Mar 22, 2026
3 checks passed
@FrozenLemonTee FrozenLemonTee deleted the pre-0.3.0 branch March 22, 2026 13:52
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