ash icon indicating copy to clipboard operation
ash copied to clipboard

Go over all reference docs

Open zachdaniel opened this issue 10 months ago • 4 comments

  • [ ] ash
  • [ ] ash_postgres
  • [ ] ash_phoenix
  • [ ] ash_graphql
  • [ ] ash_authentication
  • [ ] ash_authentication_phoenix
  • [ ] ash_archival
  • [ ] ash_json_api
  • [ ] ash_admin
  • [ ] ash_state_machine
  • [ ] ash_appsignal
  • [ ] ash_oban
  • [ ] ash_money
  • [ ] ash_double_entry
  • [ ] ash_paper_trail
  • [ ] ash_sqlite
  • [ ] ash_csv
  • [ ] ash_cloak

All functions & modules need docs, and all function heads (of all arities, watch out for optional arguments) need specs & docs

Additionally, functions and macros in Ash should link to relevant guides far more often. See #1491 for more.

zachdaniel avatar May 01 '24 18:05 zachdaniel

I was just running through the Getting started guide on rc.40 and found a weirdly worded section in Querying without persistence

The examples above could be easily implemented with Enum.filter, but the real power here is to allow you to use the same tools when working with any data layer. If you were using the AshPostgres.DataLayer data layer.

Specifically the last sentence doesn't quite fit right.

Thought that comment might fit here better than a new issue.

bianchidotdev avatar May 03 '24 01:05 bianchidotdev

😆 thanks for pointing it out, and yeah that definitely seems just like an extra sentence. Will remove!

zachdaniel avatar May 03 '24 01:05 zachdaniel

Fixed :)

zachdaniel avatar May 03 '24 01:05 zachdaniel

As mentioned in the just closed #1491 I think particularly useful would be to have links everywhere. Link from each function/macro to a corresponding guide that lets me learn about a topic e.g. from validate present to the validations guide.

RoyalIcing avatar Oct 02 '24 04:10 RoyalIcing