Create documentation

[tomtitherington]

Summary

Create the first version of the project's documentation - not the repository README.

Details

Deliverables:

• [ ] Create a Notion document
• [ ] Welcome page: intro paragraph, getting started (explain its still in development), contributing, join the Slack
• [ ] Why Crumpet
• [ ] Examples (aka. What you can build with Crumpet)
• [ ] How Crumpet works
• [ ] Concepts
• [ ]

Notes:

The idea here is to position the content of the docs like Crumpet has been released and work backwards from there (the Amazon way). This way we can measure appetite, help validate the proposition and generate traction. Start with a Notion site and then move to a Docusaurus style of docs.

This is also a good exercise for me since I have a bunch of txt notes on how the project is structured and works. Putting this in one place can only help.

[tomtitherington]

Some graphic along these lines to illustrate what you can build with Crumpet.

[tomtitherington]

example-readme.md

[tomtitherington]

Some notes on copy

"The company stemmed from their shared experience of bridging the gap between dev and ops teams, aiming to align their viewpoints and solve joint problems. They develop a platform to help companies monitor cloud computing."