[Docs] Restructure doc page and add AI gallery #3331
Conversation
There was a problem hiding this comment.
Awesome @Michaelvll! Did a pass.
Is it possible to make the hover underline show up in the same position as an active tab's underline?
Otherwise feels a bit weird.
Shall we consider adding a "New" button in the AI Gallery tab?
Co-authored-by: Zongheng Yang <[email protected]>
Co-authored-by: Zongheng Yang <[email protected]>
Co-authored-by: Zongheng Yang <[email protected]>
Co-authored-by: Zongheng Yang <[email protected]>
Co-authored-by: Zongheng Yang <[email protected]>
…t into docs-with-gallery-2
|
Checked out the latest top nav bar hover behavior. The hover underline "connects" to an active tab's underline, which is a bit unusual. Maybe there's another aesthetic to use there? E.g.,
|
There was a problem hiding this comment.
LGTM, thanks @Michaelvll!
Final Q:
Shall we consider adding a "New" button in the AI Gallery tab?
Mainly to check how it looks.
|
|
||
| Readers can directly execute the SkyPilot YAMLs on their own infrastructure, such as cloud VMs or Kubernetes. | ||
|
|
||
| .. image:: https://imgur.com/oHPjeCi.png | ||
| .. image:: https://imgur.com/POFdmiEx.png |
There was a problem hiding this comment.
N/A now? https://skypilot.readthedocs.io/en/docs-with-gallery-2/gallery/index.html Shall we use our own?
There was a problem hiding this comment.
Oops, added it to our own images/ folder now. Thanks!
| @@ -55,7 +55,7 @@ We welcome contributions from the community. If you would like to contribute, pl | |||
|
|
|||
| 1. Fork the `SkyPilot repository <https://github.com/skypilot-org/skypilot>`__ on GitHub. | |||
| 2. Create a new folder for your own framework, LLM model, or tutorial under `llm/ <https://github.com/skypilot-org/skypilot/tree/master/llm>`__. | |||
| 3. Add a README.md, a SkyPilot YAML, and other necessary files to run the AI project. | |||
| 3. Add a README.md, a SkyPilot YAML, and other necessary files to run the AI project. (Relative paths are not supported. Please use GitHub URLs for the references to the files.) | |||
There was a problem hiding this comment.
Was thinking this hint can exist ~L16 as a comment for reviewers to pay attention to. To make this section shorter.
There was a problem hiding this comment.
Sounds good! Added the comment instead.
Here is an example of how |
Find the latest doc for this PR at: https://skypilot.readthedocs.io/en/docs-with-gallery-2/docs/index.html
TODO:
Improve the doc for axolotlFuture TODOs:
Tested (run the relevant ones):
bash format.shpytest tests/test_smoke.pypytest tests/test_smoke.py::test_fill_in_the_namebash tests/backward_comaptibility_tests.sh