Adapters - Guide Docs

[pietrop]

Following up from #38 added some guides in the docs for how to create new adapters.

At draft stage, feedback welcome.

especially on

• structure of the guide
• clarity of the explanation
• steps of the giuide
• refactor*

*refactor: as in should we re-factor the code (perhaps at a later stage) to make the adapter creation process even more straightforward?

[jamesdools]

Don't think you really need this + line 34 as well.

[pietrop]

this? as in the custom data? or the example code?

[jamesdools]

Also 😱

are those gigantic json files necessary?

[pietrop]

Also 😱

are those gigantic json files necessary?

lol, yeah no, I mean they are for the tests, altho they could be made smaller. I had made a note that we should see if we can exclude them from the bundle so that they are not shipped with the packaged component.

for example in package.json we have:

"build:component": "rimraf dist && NODE_ENV=production babel src/lib --out-dir dist --copy-files --ignore __tests__, spec.js, test.js ,__snapshots__",

so there might be a way to add them to the ignore list. eg adding a naming convention like some name+.sample.json?

[pietrop]

I've excluded sample files adding .sample.js and .sample.json file extension

[pietrop]

merging as a first draft