Initial structure for documentation project

[benjaoming]

Proposal for a basic Sphinx example.

Scope:

• An example project that we want people to copy/adapt
• Reflects critical best practices
• (I'll transfer what is transferable to the example-mkdocs-basic)

All comments and suggestions that can help to achieve the above are much appreciated.

[ericholscher]

This is a great start, but I'd love to see what the README looks like. That's going to be the users primary interaction point, so that's going to be where we really need to focus on making sure the content is nice and works well.

[benjaoming]

@ericholscher I made some more extensive updates now, making the example project a bit more "self-serving".

[ericholscher]

This is great! Lots of little nitpicks and style things, but overall I really like the content and think it's very close.

[ericholscher]

This feels like a really odd transition without context on the index page. Should this be on another subpage that we link to from the Rendered docs?

[benjaoming]

I kind of agree... it's an attempt to have an example project while at the same time showing how we would document a fictive software project. So this content would normally be in the index.rst page?

[ericholscher]

We definitely want to merge this before shipping the main PR, so 👍 'ing it as well, since I think it's really close

[benjaoming]

Thanks for the great and super-helpful review @ericholscher 🙏