pact.io icon indicating copy to clipboard operation
pact.io copied to clipboard

Getting started guides aren't very user friendly

Open TimothyJones opened this issue 6 years ago • 6 comments

Pact.io directs new users to the Readme pages of the various pact implementations. It would be an improvement to have step-by-step guides for getting started.

TimothyJones avatar May 09 '18 02:05 TimothyJones

Agreed, when are you going to be done? :P

mboudreau avatar May 09 '18 02:05 mboudreau

Well, I can get started on the Javascript one when you merge the other PR ;)

Putting these issues in is at least half for me anyway - I don't want to forget things, and putting them on a public todo list seemed better than squirrelling them away in a notebook. Plus, I don't mind if someone else completes any documentation I was planning to do.

TimothyJones avatar May 09 '18 03:05 TimothyJones

PR #46 adds a quickstart guide for Javascript. If it's well received, I can do similar guides for the other languages and frameworks.

TimothyJones avatar May 09 '18 06:05 TimothyJones

Totally agree here and want to get this addressed :)

Great work on the JS guide, I've only been able to see it via this PR as this is the current JS quickstart guide on the website.

I think we lost the changes somewhere in the website migration

https://github.com/pact-foundation/pact.io/blob/ce4b5cdccbc0ef5677469ec5068484ed679272c9/implementation_guides/javascript.md

the new location is here

Looking at the history

https://github.com/pact-foundation/docs.pact.io/commits/master/website/docs/implementation_guides/javascript.md

This older page was copied over https://github.com/pact-foundation/docs.pact.io/blob/55f3efaba63e9fbf3722b0950a5792521bd7ef8d/website/docs/implementation_guides/javascript.md

Which makes me wonder what else we missed out along the way 🤔

YOU54F avatar May 25 '22 19:05 YOU54F

Good find!

bethesque avatar May 25 '22 22:05 bethesque

There's quite a bit of documentation that I wrote that I can't find any more - I just thought it had been moved elsewhere, but maybe it was deleted.

TimothyJones avatar May 26 '22 01:05 TimothyJones