Split up README into multiple pages of documentation

[simonw]

I can use the same tech as https://django-sql-dashboard.datasette.io/en/stable/ - see https://github.com/simonw/django-sql-dashboard/tree/main/docs

• Configure Read the Docs
• Split documentation up into pages
• Add new Contributing page with notes on how docs work (including Cog)
• Vanity domain - probably shot-scraper.datasette.io
• Shrink the README and point it to the new docs
• Ship a release and check that Read the Docs has a "stable" as well as a "latest"

[simonw]

I started by just copying README.md into docs/index.md and configuring MyST and Read the Docs.

This first prototype of the new documentation is now hosted at https://shot-scraper.readthedocs.io/en/latest/

Next steps are in the issue description above ^

[simonw]

For the domain, I'm torn between shot-scraper.datasette.io and registering a domain specifically for shot-scraper.

I'm worried that it's not particularly relevant to Datasette. But I also don't want to have to pay for another domain name for the rest of time.

I already added it to https://datasette.io/tools/shot-scraper though - and the scraping mechanism is very aligned with the rest of the Datasette ecosostem. So I think shot-scraper.datasette.io is OK.

[simonw]

Configured shot-scraper.datasette.io here - https://readthedocs.org/dashboard/shot-scraper/domains/13242/edit/ - following instructions in https://til.simonwillison.net/readthedocs/custom-subdomain

Now waiting for certificate.

[simonw]

Got a surprising certificate error in the Read the Docs interface:

SSL certificate status: The requested hostname resolves to a Cloudflare zone that is not owned by you. HTTP domain control validation (DCV) cannot be completed. Update this hostname to resolve to your zone and PATCH to try again.

[simonw]

Maybe because I had only setup the CNAME a few minutes before-hand?

http://shot-scraper.datasette.io/ is showing a Clouflare page:

I'm going to leave this for an hour and try again.

[simonw]

... no wait, I think this is because:

I set it to readthedocs.org but I should have set it to readthedocs.io!

[simonw]

OK, https://shot-scraper.datasette.io/ works now!

[simonw]

New structure is now live on https://shot-scraper.datasette.io/en/latest/

[simonw]

I changed the default version to stable here: https://readthedocs.org/dashboard/shot-scraper/advanced/

https://shot-scraper.datasette.io/en/stable/