Skip to content

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

Merged
merged 5 commits into from
Sep 30, 2024
Merged

Conversation

zmitchell
Copy link
Member

No description provided.

@zmitchell zmitchell force-pushed the zmitchell/712-quickstart-guide branch from 6422ce3 to 589b407 Compare September 25, 2024 18:57
Copy link

@stahnma stahnma requested a review from ghudgins September 26, 2024 14:48
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
Copy link
Contributor

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]
Copy link
Contributor

@jennymahmoudi jennymahmoudi Sep 27, 2024

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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

YES!!!

Copy link
Contributor

@ghudgins ghudgins left a 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.

@zmitchell
Copy link
Member Author

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.

@zmitchell zmitchell force-pushed the zmitchell/712-quickstart-guide branch from 4733683 to f4450f8 Compare September 30, 2024 21:11
Copy link

@zmitchell zmitchell merged commit 7120c16 into preview Sep 30, 2024
3 checks passed
@zmitchell zmitchell deleted the zmitchell/712-quickstart-guide branch September 30, 2024 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants