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.

Sign up for GitHub

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

Jump to bottom

Basic Documentation #842

Closed
tobiasBora opened this issue Jan 27, 2024 · 2 comments · May be fixed by #1042
Closed

Basic Documentation #842

tobiasBora opened this issue Jan 27, 2024 · 2 comments · May be fixed by #1042

Comments

@tobiasBora
Copy link

It seems like dream2nix is a great tool… but it has a really poor (if any) beginner-friendly documentation. Why isn't there in the documentation a simple set of instructions to set-up dream2nix? Seems like it would be much more helpful than a few, possibly outdated, examples.
@supermarin
Copy link

@DavHau can this please be addressed?

The current state of the docs is completely unusable.
The -> to the docs link recursively links to the homepage.
Any pointers on how to get started with a basic python environment would be appreciated.

@ahihi
Copy link

ahihi commented Aug 24, 2024

just chiming in to point out that there are new Getting started and Python & pip guides on the website. i found these very helpful, thanks a lot! :)

@DavHau DavHau closed this as completed Aug 25, 2024
supermarin added a commit to supermarin/dream2nix that referenced this issue Sep 3, 2024
@supermarin
Redirect "To the docs" link to "Getting Started"
2b3052b 
This link is dead when clicked from dream2nix.dev.
Make it point to actual documentation. Closes nix-community#842
@supermarin supermarin mentioned this issue Sep 3, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Redirect "To the docs" link to "Getting Started" supermarin/dream2nix
4 participants
@supermarin @ahihi @tobiasBora @DavHau