Make sure FAQ is up to date

[JeneaVranceanu]

What piece of the framework are having the lack of docs?

https://github.com/web3swift-team/web3swift/wiki/FAQ

What bit of docs would you like to have?

It is not exactly a documentation request, but rather a request to make sure FAQ is up to date.

[janndriessen]

A question for me here would be do we want a FAQ and docs? Or are frequently asked questions just a hint to what should go into the docs?

[yaroslavyaroslav]

Well, the docs at least in nearest future must be within GitHub hosted DocC docset. Like it's cheap in terms of amount of work and absolutely terrific in terms of conveniency.

But speaking about the FAQ, I'm in doubt. The best way would be to put it there as well, as DocC provides a way to put additional md text within docsets. But this would be not so cheap in both cases to expand and to update the given one FAQ entities.

[janndriessen]

Forgot about DocC. That def makes sense for docs. Personally, I'd think in the future there should be docs, examples and FAQ.

A lot what's in FAQ right now though should be in examples. I'd put only questions in there that don't really have a place anywhere else e.g. common problems like no. 1 on the FAQ. On the other hand this could also be a section in the README e.g. common issues.

(just a brain dump)