Commcare: update documentation

[hunterachieng]

Summary

Update commcare documentation with more examples and better formatting

Fixes #775

Details

Add more examples and update the commcare documentation

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to know!):

• Code generation (copilot but not intellisense)
• Learning or fact checking
• Strategy / design
• Optimisation / refactoring
• Translation / spellchecking / doc gen
• Other
• I have not used AI

You can read more details in our Responsible AI Policy

Review Checklist

Before merging, the reviewer should check the following items:

• Does the PR do what it claims to do?
• If this is a new adaptor, added the adaptor on marketing website ?
• Are there any unit tests?
• Is there a changeset associated with this PR? Should there be? Note that
  dev only changes don't need a changeset.
• Have you ticked a box under AI Usage?

[josephjclark]

Just a bit of pasted code that needs removing please

[josephjclark]

Looks good

Aleksa said something about configuration in the issue - is that anything that needs addressing here?

[hunterachieng]

Looks good

Aleksa said something about configuration in the issue - is that anything that needs addressing here?

Not really, the configuration docs is accurate and up to date

[josephjclark]

@hunterachieng what about the Sample Configuration? Should that have a user/pass or apikey? Just as a starting point for users. Maybe an app id too?

@josephjclark This has been fixed

[josephjclark]

@hunterachieng Oh I see, the sample configuration comes from required keys. hmm.

We can't make username and password required, because they're not required if you pass an API key. So we'll have to live without those in the example.

I presume appId is always required though?

What about hostURL? Is that really required or can we (do we?) safely default that to commcarehq?

[hunterachieng]

@hunterachieng Oh I see, the sample configuration comes from required keys. hmm.

We can't make username and password required, because they're not required if you pass an API key. So we'll have to live without those in the example.

I presume appId is always required though?

What about hostURL? Is that really required or can we (do we?) safely default that to commcarehq?

@josephjclark hostURL is a required field

[josephjclark]

Ok @hunterachieng , thank you! I'll get this merged in a minute