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

Potential improvements for documentation #142

Open
j-n-f opened this issue Oct 5, 2024 · 0 comments
Open

Potential improvements for documentation #142

j-n-f opened this issue Oct 5, 2024 · 0 comments

Comments

@j-n-f
Copy link

j-n-f commented Oct 5, 2024

I had a little trouble getting started with this crate.

The documentation for ructe::Ructe is fairly complete and describes everything that needs to be done.

I think this content should be on the main page. The preamble on what ructe is and what it does is good. If there were a section after that like "Getting Started", and then include all the steps from the Ructe page it'd be golden.

If that feels redundant, then a "Getting Started" section that just says "See documentation for Ructe" would be fine.

I think what's confusing is the paragraph before that which effectively says "this is a minimal build.rs." I think it will mislead people into thinking "this is what I have to do to make this work", and they'll be confused when they go to use something under the templates module and find that the compiler can't find it (because of the missing include!(...); this was my experience).

With all that said, cheers for the excellent work. I'm switching to ructe after having issues with tera, and templates rendering nearly 20x faster is really cool.

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