-
Notifications
You must be signed in to change notification settings - Fork 7
feat: add new quickstart guide #39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
6422ce3
to
589b407
Compare
🚀 Deployed on https://66f45d7495419705d03a8eb3--floxdocs.netlify.app |
docs/index.md
Outdated
When you activate the environment you can see that `flox [my_project]` is | ||
prepended to your prompt so that you can see that you're inside the | ||
environment. | ||
If you have more than one environment activate (you can stack them!) this prompt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: activated
environment. | ||
If you have more than one environment activate (you can stack them!) this prompt | ||
will show a list of the active environments. | ||
Whether to show this prompt is configurable, see [`flox config`][config] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This feels like a good time to mention what to do if you don't see the prompt (bc of zsh theme, etc). Perhaps?
If you don't see the prompt change, ...do X... If you want to disable the prompt, see [`flox config'][config].
If there isn't a simple thing they can do, can we just say "If you use custom zsh themes, your prompt may not change."
2. Create an environment with `flox init`. | ||
3. Find your dependencies with `flox search` and `flox show`. | ||
4. Install dependencies with `flox install` | ||
5. Add environment variables, shell hooks, and services with `flox edit`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
YES!!!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
overall LGTM.
non-blocking feedback: I get why we're doing it but there is a bit of a flow oddity to always switch back to installing go from the language specific initial section. but yeah, it's probably too much to maintain all those paths so I totally get it.
Yeah I chose to go that route because the portions that I've done in a language specific way have actual differences based on the language whereas the Go-only parts are mostly generic. As a first pass I think this is fine and I don't feel like it disrupts the flow too much. |
4733683
to
f4450f8
Compare
🚀 Deployed on https://66fb14c69dee2626ea58b2a7--floxdocs.netlify.app |
No description provided.