Open VestOfHolding opened 1 year ago
@VestOfHolding Good question. I've recently found out about this project and the first thing I noticed is the old and possibly outdated docs.
Contributions are welcome! And if you have more specific questions, instead of just complaining, please do ask
@saudet Why would you use the term "complaining" for someone just discovering your project? It sounds somewhat aggressive and dismissive.
So for an opensource project, people should just highlight issues with the source code and not mention anything they notice about the associated documentation which is the first point of contact for new users trying to get details about an opensource project?
Contributions are welcome! And if you have more specific questions, instead of just complaining, please do ask
Yikes dude. Framing what I'm pointing out as just complaining is pretty wild. I'm looking at implementing my first project with the library and don't have near the expertise to contribute documentation/tutorial changes, and thinking someone like me might be able to is also very strange.
Frankly, trying to politely ask if the current documentation can be up to date, or where else to look for the best help, shouldn't be something that garners that type of reaction.
I could see something like "this documentation isn't helpful" as "just" complaining, but a bulleted list along with a follow-up acknowledging the possibility of better documentation elsewhere... feels pretty specific to me?
I wonder if this is a culture disconnect. I can see there are a couple of Q&A posts under the Discussions tab, is it possible that would be a more receptive forum for these questions? If so, that feels like both a good candidate for a README, and a good redirect for a new user reaching out.
The README file is up-to-date, including the links it contains, or at least that's the intention, so if there's an issue there, please do point it out, but that's about the extent that I can afford to maintain myself. If you want other pages written by other people to be up-to-date, like I keep saying contributions are welcome! I cannot possibly do everything all by myself. I am just one guy not getting paid in any way to work on this.
I noticed a few of the wiki tutorial/documentation pages haven't been updated in years. Does the info on these pages still represent the best way to do things and generally best info?
Examples:
And those March 2015 "updates" were just migrating the pages from Google Code.
If not these pages, are there better places where documentation/tutorials are stored?