Documentation updates

[jknndy]

Re-reviewed all docs and made a ton of changes/corrections.

Appreciate any feedback!

@mlduff , mind taking a look?

[mlduff]

Just one small improvement suggestion, but a very good uplift, well done!

[strangetom]

Thanks for making the effort to review the documenation, @jknndy. Definitely worthwhile, looking at some of the mistakes you've found.

[jayaddison]

Perhaps a strange question: has anyone had experience of sitting with newcomers to recipe-scrapers and observing them read through the documentation?

While reading the changes I'm trying to get a sense for how the documentation -- particularly the in-depth scraper guide -- reads logically. So far it seems pretty good to me, but there's no substitute for feedback from people learning it for the first time.

[jknndy]

Perhaps a strange question: has anyone had experience of sitting with newcomers to recipe-scrapers and observing them read through the documentation?

Not personally but this is exactly the reason I pinged @mlduff for a review at the start! I believe they started contributing to the library after the original docs were published which made their input useful here.

We could open a discussion or issue inviting new developers to post about their experience with the docs / where they might have gotten stuck or thought things could be better outlined? Possibly including a link to the discussion at the top of each doc file & somewhere in the readme.

[mlduff]

@jknndy Can confirm I started contributing recently, reading through the docs initially. I found it fairly easy to understand, the page I frequented the most was the one detailing each of the scraper functions (and then Ctrl+F searching to see if websites were supported).

[jknndy]

@mlduff , were there any particular parts of the dev process that you thought the documentation was lacking? I agree that the scraper functionality page is our most expansive so maybe not but you never know!

[jonzey231]

Perhaps a strange question: has anyone had experience of sitting with newcomers to recipe-scrapers and observing them read through the documentation?

While reading the changes I'm trying to get a sense for how the documentation -- particularly the in-depth scraper guide -- reads logically. So far it seems pretty good to me, but there's no substitute for feedback from people learning it for the first time.

I'm having an awful time running the scraper on Windows via WSL with pip installed. I'm just trying to scrape all the HelloFresh URLs to import into Mealie.

[jayaddison]

@jonzey231 please could you create a separate GitHub issue thread with details of the problem you're experiencing? Thank you!