Skip to content

Refine documentation and publish client image for releases - #8

Merged
yyyyyt123 merged 5 commits into
NetX-lab:mainfrom
yyyyyt123:codex/release-image-on-tag
Aug 24, 2026
Merged

Refine documentation and publish client image for releases#8
yyyyyt123 merged 5 commits into
NetX-lab:mainfrom
yyyyyt123:codex/release-image-on-tag

Conversation

@yyyyyt123

Copy link
Copy Markdown
Collaborator

This pull request updates the documentation and CI workflow to reflect the NetOpsBench v0.2.0 release, which introduces major new benchmark profiles (Xlarge CLOS and Fat-tree), a native Rust client agent, and improvements to large-topology operation, scoring, and results publication. The documentation is reorganized to highlight the new release, clarify methodology, and separate legacy results. The CI workflow is streamlined to only trigger on tags, and Docker image tagging is updated for consistency.

Major v0.2.0 release and documentation updates:

  • Release notes and documentation structure:

    • Added dedicated release notes for NetOpsBench v0.2.0, describing new Xlarge CLOS and Fat-tree profiles, the native client agent, and runtime improvements (docs/content/docs/releases/v0.2.0.mdx, docs/content/docs/releases/meta.json, docs/content/docs/meta.json, docs/content/docs/index.mdx, [1] [2] [3] [4].
    • Updated the documentation index and quickstart to reference the new profiles and recommend XS for installation checks (docs/content/docs/index.mdx, docs/content/docs/quickstart.mdx, [1] [2] [3].
  • Benchmark methodology and results presentation:

    • Updated methodology and results to include Xlarge and Fat-tree scales, clarify naming conventions, and explain new scoring metrics (Diagnosis score, Fault detection F1) (docs/content/docs/run-benchmarks/methodology.mdx, README.md, [1] [2] [3] [4].
    • Added a new legacy results page to retain earlier cross-model benchmarks for historical comparison (docs/content/docs/run-benchmarks/legacy-results.mdx, docs/content/docs/run-benchmarks/meta.json, [1] [2].

Operational guidance and cleanup improvements:

  • Added specific recommendations for cleaning up large topologies and avoiding broad Docker cleanup commands (docs/content/docs/debug-operate/observability.mdx, [1] [2].

CI/CD workflow simplification:

Other documentation improvements:

  • News and overview sections in the README.md are updated to highlight the v0.2.0 release, new profiles, and dataset publication (README.md, [1] [2] [3].

These changes ensure that the documentation, workflow, and public benchmark results are aligned with the new large-scale capabilities and agent lifecycle in NetOpsBench v0.2.0.

@yyyyyt123
yyyyyt123 merged commit eecf716 into NetX-lab:main Aug 24, 2026
8 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.

1 participant