Skip to content

[codex] polish api and tutorial docs#451

Merged
k82cn merged 1 commit into
xflops:mainfrom
k82cn:codex/docs-api-tutorial-polish
May 13, 2026
Merged

[codex] polish api and tutorial docs#451
k82cn merged 1 commit into
xflops:mainfrom
k82cn:codex/docs-api-tutorial-polish

Conversation

@k82cn
Copy link
Copy Markdown
Contributor

@k82cn k82cn commented May 12, 2026

Summary

  • remove obsolete docs/blogs content and point README documentation links at current docs
  • move the standalone RFE368 test plan into its design folder
  • polish API, tutorial, SDK, and flmadm docs against the current implementation
  • update install Make targets to pass the required flmadm install --all profile flag and show object-cache startup

Validation

  • git diff --cached --check
  • make -n install-dev
  • stale deleted-doc/reference scans
  • relative markdown link check for edited docs

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request significantly updates the project's documentation and build infrastructure to align with recent architectural changes. Key updates include the integration of the object cache into the installation and configuration guides, the adoption of uv for Python dependency management, and a comprehensive rewrite of the Python SDK and Runner API documentation. Additionally, the PR removes several outdated blog posts, refines the gRPC API by removing the batch_index field from scheduling messages, and introduces an installer field for application specifications. I have no feedback to provide as there are no review comments.

@k82cn k82cn marked this pull request as ready for review May 12, 2026 22:58
@codecov
Copy link
Copy Markdown

codecov Bot commented May 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@k82cn k82cn merged commit 0b66b64 into xflops:main May 13, 2026
6 checks passed
@k82cn k82cn deleted the codex/docs-api-tutorial-polish branch May 13, 2026 01:26
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