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

[Documentation] Certain aspects of how to use nixago feels ambiguous #52

Open
JeremiahSecrist opened this issue Apr 11, 2023 · 0 comments

Comments

@JeremiahSecrist
Copy link

Problem Statement

While attempting to utilize this project, I encountered difficulty in comprehending the exact method for implementing it into my own project. Despite perusing the documentation, I did not come across any fully functional examples. However, I was able to gain insight after reading your informative blog post, specifically the Configure Nixago section. It should be noted that I am aware of the existence of the template section.

Solution Proposal

I suggest that a second template be added to the templates section, which demonstrates a more complete functioning flake with interconnected parts. Additionally, the inclusion of comments highlighting the purpose of each section would be beneficial. Furthermore, it would be helpful to mention this template within the documentation to aid users in finding it.

Addendum

I want to emphasize that I am providing this feedback constructively and not intending to cast any negative criticism. While I did experience difficulty in grasping the project, I am appreciative of your efforts and wish you all the best.

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

No branches or pull requests

1 participant