Update intro and flux example #1275
Conversation
docs/index.rst
Outdated
| @@ -13,6 +11,38 @@ | |||
| <a class="github-button" href="https://github.com/run-house/runhouse/fork" data-icon="octicon-repo-forked" data-size="large" aria-label="Fork run-house/runhouse on GitHub">Fork</a> | |||
| </p> | |||
|
|
|||
| Why Runhouse? | |||
There was a problem hiding this comment.
I think we can drop this or move it below the intro sentence. Page layout look kind of odd when you go straight from H1 to H2 without any intro paragraph. Technically the sentence following is more "what" than "why anyway.
There was a problem hiding this comment.
Hmm I don't super love it either way somehow lol
There was a problem hiding this comment.
It's pretty standard to go H1 -> content -> H2 -> more content
https://modal.com/docs/guide
https://python.langchain.com/docs/introduction/
https://docs.baseten.co/welcome
https://reactnative.dev/docs/getting-started
https://nextjs.org/docs (minimal but still)
There was a problem hiding this comment.
Went down a rabbit hole questioning whether or not I've been thinking of this wrong, but feeling better with Google recommending not to have headers without text - https://developers.google.com/style/headings#heading-and-title-format
| @@ -0,0 +1,102 @@ | |||
| import runhouse as rh | |||
There was a problem hiding this comment.
Is this meant to be in /examples or is it just a file to accompany a page in /guides? If the former, I think it needs an intro paragraph and h1 in comments about this line. Potentially a bit odd to start with an import statement.
There was a problem hiding this comment.
Guides + Github, not examples.
| @@ -25,7 +25,7 @@ make sure our AWS credentials are set up: | |||
| $ aws configure | |||
| $ sky check | |||
| ``` | |||
| We'll be downloading the Llama2 model from Hugging Face, so we need to set up our Hugging Face token: | |||
examples/flux/readme.md
Outdated
| @@ -0,0 +1,32 @@ | |||
| # Deploy Flux1 Schnell on AWS EC2 | |||
|
|
|||
| See a more [rich explanation](https://www.run.house/examples/host-and-run-flux1-image-genai-aws) | |||
There was a problem hiding this comment.
If this isn't going in Examples, then this needs to change ☝️
There was a problem hiding this comment.
Good call! Changed to guides
No description provided.