Skip to content
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

Streamline "Getting Started" documentation #631

Open
sallymatson opened this issue Dec 4, 2024 · 3 comments · May be fixed by #636
Open

Streamline "Getting Started" documentation #631

sallymatson opened this issue Dec 4, 2024 · 3 comments · May be fixed by #636
Assignees

Comments

@sallymatson
Copy link
Collaborator

@sallymatson sallymatson self-assigned this Dec 4, 2024
@hrlai
Copy link
Collaborator

hrlai commented Dec 9, 2024

Hi @sallymatson I was about to tackle the same issue and glad to have checked here. I agree that re: point 1 because it duplicates with the Example page.

We might be able to remove the --outpath and --logfile options from

ve_run /path/ve_example/config \
    --outpath /path/ve_example/config/out \
    --logfile /path/ve_example/out/ve_example.log

for brevity for new users who are less familiar shell (at least as a start). We could introduce them at a later stage.

Before I mess it up, are you working on this already in a branch / fork?

@hrlai hrlai self-assigned this Dec 9, 2024
@sallymatson
Copy link
Collaborator Author

Hi @hrlai yes, I have started working on it! I hope to have a PR in the next few days for review. Would you like me to add you as a reviewer, so you can see what I was thinking and offer further input?

@hrlai
Copy link
Collaborator

hrlai commented Dec 9, 2024

Sure @sallymatson :) Happy to review. I am approaching this as someone who has near-zero experience with running Python scripts (and have no streamlined way to run bash / shell simultaneously) so will add some thoughts on how to make the tutorial accessible.

@sallymatson sallymatson linked a pull request Dec 10, 2024 that will close this issue
5 tasks
@sallymatson sallymatson linked a pull request Dec 10, 2024 that will close this issue
5 tasks
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 a pull request may close this issue.

2 participants