Configuration page needs updates

[wemeetagain]

Issues seen while migrating lodestar to latest libp2p:

• configuration page references peer store "persistence", no longer an option, should use PersistentPeerStore instead
• persistent: boolean listed in an unused interface in src/index.ts
• dialer: {...} referenced in configuration page, should instead be under connectionManager
• ...

[achingbrain]

Hand-written docs do get out of sync from time to time. Would you like to submit a PR that brings everything up to date?

[wemeetagain]

I have a branch in progress. waiting on a fix for https://github.com/bbc/typescript-docs-verifier/issues/22

[BigLep]

@wemeetagain : we're unblocked here now right?

[wemeetagain]

Yes this is unblocked. It may be useful to break this work up into separate PRs since there's a lot of changes required. I can start with doc/CONFIGURATION.md.

[maschad]

@wemeetagain I have a draft PR here to introduce typescript-docs-verifier to check the configs , I'd be happy to help with updating the config docs if you could point me to the branches you had started on.

Given we will have generated docs once https://github.com/libp2p/js-libp2p/issues/1455 is closed, I don't think we would need to document some of the internal options and type descriptions.

@achingbrain do you think we should add typescript-docs-verifier as a feature to aegir in order to use it here?