Giters

dat-ecosystem-archive / docs

Documentation resources for dat and the surrounding ecosystem [ DEPRECATED - see https://github.com/hypercore-protocol/new-website/tree/master/guides for similar functionality. More info on active projects and modules at https://dat-ecosystem.org/ ]

Home Page:https://dat-ecosystem-archive.github.io/docs/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Dat Network Protocol specification needs to be updated

aschrijver opened this issue · comments

commented

For my message layer research wrt hypercore-protocol I was referred to the dat network protocol specification, but found it outdated in places.

For instance message no. 0 is called Register but in schema.proto it has become Feed.

I have made a proposal in Discussions project to auto-generate docs from schema.proto:

commented

Demonstration + documentation of auto-generation options using TravisCI

commented

Nice! We use ecosystem-docs to pull in data from other repositories and display on the docs page, e.g. hypercore readme. I wonder if we can hack that to pull in the auto doc page?

Feel free to PR any error in the paper . We should definitely have that be correct as well!

commented

All the docs are now in the specs of my test document. Probably with some tweaking the doc can be added to the correct location of docs.datproject.org (either triggered from docs or from hypercore-protocol project travis-ci build.

I'll look at ecosystem-docs...