Add documentation for consumers

[garvankeeley]

No description provided.

[chrmod]

Hi @garvankeeley, we at cliqz.com are running a Firefox for iOS fork https://github.com/cliqz/user-agent-ios
We find it very hard to use MappaMundi without having a top level overview on how it works or what it is suppose to do.
Any documention would help a lot. Thanks in advance!

[isabelrios]

Hi @chrmod sorry for jumping in but I may be able to help you with that since I work on the test automation for Firefox-iOS and I've been using MappaMundi for some time now.
Let me share this link where we added information about our screenGraph, sorry since there might be some out of date info, but in general I think it may be useful:
https://github.com/mozilla-mobile/firefox-ios/wiki/FxScreenGraph-and-XCUITest

Feel free to ask as many questions as you have, I will try to help :)

[chrmod]

@isabelrios thanks for the link, it helped a lot!

There are couple things that are not covered:

• MMScreenGraph#addScreenAction
• MMScreenStateBuilder#noop

With new knownledge we were able to fix couple tests we broke due to UX changes of our browser. ghostery/user-agent-ios#875

How about you commit this documentation as MappaMundi README?

[isabelrios]

Hey @chrmod, let me add some examples for those questions:
MMScreenGraph#addScreenAction
MMScreenStateBuilder#noop IIRC, This was to have an state in which you don't go to any other screen, like no operation there

Hope that helps :)
Yeah I will try to add this info in a README.
BTW, I saw you are using the Graph with the same name, FxScreenGraph, it may be a good idea to kind of call your graph after your app. We are using it also in another iOS app, and it was renamed as the app name Nothing important, just a comment ;)

[chrmod]

Hi @isabelrios once again thank you for your help, it is much appriciated :-)

Would it be possible to chat about MappaMundi over matrix or something? (my id: @chrmod:matrix.org). We have some ideas to use MappaMundi for other tasks like:

• automated screenshot generation
• measuring UX regressions
• drawing app screen graph

Maybe we could collaborate on those topics if you find them interesting.

[isabelrios]

Sure @chrmod sounds good to me. I will add you.
We already use it for screenshots test, in case you want to take a look here

And at some point I think we were generating also the app screen graph. So it would be good to do that again.