Restructure the docs for a clearer learning path and correct stale content - #311
Restructure the docs for a clearer learning path and correct stale content#311JyotinderSingh wants to merge 2 commits into
Conversation
…ntent Reorganize the sidebar into Start Here, Run Jobs, Manage Infrastructure, Advanced, Examples, and Reference. Add a "How Kinetic Works" concepts page. Make profiles the primary configuration mechanism on every page, with KINETIC_* variables and flags as one-off overrides. Move the container image modes to one advanced page (containers.md) and remove execution_modes.md and advanced.md. Correct the pages against the code: job ID format, cleanup and TTL behavior, multi-host slices (tpu-v6e-8 is two hosts), no published prebuilt base images, fixed output_dir for resume, Spot pools that need spot=True, idle cluster costs, and the debug attach window. Rewrite all prose in ASD-STE100 style. Fix stale example docstrings.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #311 +/- ##
=======================================
Coverage ? 36.83%
=======================================
Files ? 83
Lines ? 15215
Branches ? 0
=======================================
Hits ? 5604
Misses ? 9611
Partials ? 0 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request performs a comprehensive update and restructuring of the Kinetic documentation and example scripts to align with the active profile configuration workflow and modern TPU naming conventions. The review feedback identifies an architectural improvement opportunity to persist reservation and spot settings as state dimensions in StackState and load_state() to prevent fragile infrastructure updates, rather than merely documenting the limitation. Additionally, a minor markdown formatting correction was suggested for the Gemma 4 fine-tuning guide to ensure proper rendering.
3 participants
Description
This PR reorganizes the documentation site so that a new user understands how Kinetic works in the first two pages. It also corrects the pages against the code and rewrites the prose to be more human-like and easier to follow.
The new flow
The sidebar now has six sections, in learning order:
Main changes
kinetic initare the primary configuration on every page.KINETIC_*variables and CLI flags are one-off overrides.execution_modes.mdandadvanced.mdare removed.result()and cleanup delete, the multi-host TPU slices (tpu-v6e-8has two hosts), the fact that Kinetic does not publish prebuilt base images, a fixedoutput_dirfor resume, Spot pools that needspot=True, and the idle cluster costs.