Beginning to think about recipes and examples, and...
# documentation
y
Beginning to think about recipes and examples, and making our documentation amazing. Would love to get some input and inspiration. • Does anyone have any great benchmarks, of documentation you've thought was really top class, • Have you seen recipes that were useful, for the kinds of use cases, you actually have, or are they usually too clean and far removed from real world implementations • Is there any particular things you would like to see showcased • What particular formats resonate with people? I know with the advent of youtube, and online courses people are learning in a multitude of different ways. As part of this initiative I have started capturing some initial brain dumps of the information I have found in a couple of GH issues Feature support overhaul Update matchers page to have examples from every language Any input is welcome, beginners and seasoned Pact pro's alike. Equally if you want to get involved from an early stage and shape the future of our documentation, please do get in touch. We will look to get an open proposal in place and start up something like a Pact season of Docs session where will we invite everyone to get involved.
❤️ 1
m
I’ve always thought the Cypress documentation was pretty good. I like that they split the API usage, from the Guides, but have the examples and workshops front and centre
👍 1
I recall loving FastAPI because it was so easy to use. The docs aren’t friendly as I remember, but I think we do a bad job of explaining our features to people. FastAPI https://fastapi.tiangolo.com/features/ do ok I’ve tried making the new (2.x.x) Pact Go docs a bit nicer with this intent: https://github.com/pact-foundation/pact-go/tree/2.x.x
AWS docs (controversial). They’re good, and you don’t realise they are good until you use another big product and realise how fragmented other product documentation is (and their APIs). AWS are so bloody consistent, it makes it easy to guess command names, flags etc.