docs: polish first release documentation#3
Merged
Merged
Conversation
Co-Authored-By: Codex <codex@openai.com> Signed-off-by: Zhengyuan Su <su.zhengyuan@u.nus.edu>
Co-Authored-By: Codex <codex@openai.com> Signed-off-by: Zhengyuan Su <su.zhengyuan@u.nus.edu>
Co-Authored-By: Codex <codex@openai.com> Signed-off-by: Zhengyuan Su <su.zhengyuan@u.nus.edu>
Co-Authored-By: Codex <codex@openai.com> Signed-off-by: Zhengyuan Su <su.zhengyuan@u.nus.edu>
Co-Authored-By: Codex <codex@openai.com> Signed-off-by: Zhengyuan Su <su.zhengyuan@u.nus.edu>
Co-Authored-By: Codex <codex@openai.com> Signed-off-by: Zhengyuan Su <su.zhengyuan@u.nus.edu>
Co-Authored-By: Codex <codex@openai.com> Signed-off-by: Zhengyuan Su <su.zhengyuan@u.nus.edu>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Complete the documentation and package-polish portion of the first-release roadmap, with manual non-code alignment against FlowMesh's released repository shape.
Changes
info.status()now uses/healthz, the stale job logs SDK method is removed, andjobs.wait()uses the server's lowercase terminal states.Design
Keep README focused on install, quick start, and navigation. Put detailed reference material under docs/ so the PyPI long description remains readable while users still have discoverable public docs in the repository. Keep issue templates, workflow names, and doc names close to FlowMesh so the two OSS repositories are easier to maintain together.
Test Plan
lumilake,deploy,job,job submit,job preview,job artifact,worker, andtraceTest Result
All listed checks passed.
Pre-submission Checklist