YaLinqo icon indicating copy to clipboard operation
YaLinqo copied to clipboard

Documentation / ReadMe: MOAR

Open Athari opened this issue 5 years ago • 1 comments

Update ReadMe and documentation to a more sensible state:

  • [x] Get rid of obsolete string lambda garbage. Cast arrays to objects. Make the code pretty, not scary mess it is now.
  • [ ] Explain basics like what from does, how to chain, how to iterate (come on man, you copypasted that on StackOverflow 10 times already). Literally anything is better than what ReadMe contains now.
  • [ ] Add FAQ with common mistakes like trying to replace ORM with YaLinqo, multiple iterations over a sequence, comparisions etc. Check issues here and on SO.
  • [ ] Tutorial. Either copy-paste Mr. X's guide or do something similar.
  • [ ] How-to / cookbook with common tasks and solutions.
  • [ ] Architecture overview (put into contributing? not that anyone is contributing...)
  • [ ] ~Links to SO maybe? That stupid "opinionated" question would be a good fit.~

Guide on what's supposed to go into a proper documentation. The link is from the only remotely useful answer to my post in r/php.

Athari avatar Jul 27 '20 00:07 Athari

The guide part seems to be a thing AI can handle. An AI-generated guide is better than no guide, right? Especially now that the intro guide by Mr. X from Tute Wall exists only on the Wayback Machine.

Also, fuck StackOverflow, it's dead.

Athari avatar Oct 08 '25 02:10 Athari