Add factories documentation

[bcdickinson]

The example in the README is useful, but a bit strained. Now, with new features starting to come in, we're definitely going to need proper docs with recipe examples to make sure this is useful to more than just people with time to read through the tests.

[jams2]

I'm happy to work on this. Before digging in, what do we think about changing from RST/Sphinx to mkdocs? Personally I find markdown more pleasant to write than RST, but my personal preference is not a good reason to turn everything upside down :)

[easherma]

I feel similarly (could help with docs, prefer markdown)

[thibaudcolas]

Looking at this in 2024 – we’ve fully migrated Wagtail docs from rST to Markdown, so I think doing the same here is a "when" rather than "if". @bcdickinson @jams2 @easherma if I do the tooling migration for the package – will you write the docs? 😬

@mvantellingen it looks like you’re currently the only one with admin permissions for the project in Read the Docs, would you be able to invite me or others so we have the best possible ways to troubleshoot any issues?

[jams2]

@thibaudcolas yep, I'm up for that.

[easherma]

Happy to help!

…

On Thu, Mar 21, 2024 at 4:00 AM Joshua Munn ***@***.***> wrote: @thibaudcolas <https://github.com/thibaudcolas> yep, I'm up for that. — Reply to this email directly, view it on GitHub <#58 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACQNGT3HWESR2VNJJICQJJLYZKORVAVCNFSM53RR36O2U5DIOJSWCZC7NNSXTN2JONZXKZKDN5WW2ZLOOQ5TEMBRGE3DOOBQGM3A> . You are receiving this because you were mentioned.Message ID: ***@***.***>