EYBlockchain / nightfall_3

a mono-repo containing an optimistic version of nightfall
Creative Commons Zero v1.0 Universal
260 stars 57 forks source link

doc update and Gitbook #1426

Closed Westlad closed 1 year ago

Westlad commented 1 year ago

What does this implement/fix? Explain your changes.

The documentation in Nightfall needs some work. This PR goes some way to fixing that. It simplifies the root README.md, which was long, not entirely correct and had extremely varying levels of datail. Now, it just shows you how to run up a local test instance, and where to get help. For everything else (greater levels of detail about running and configuring Nightfall) there is now a linked Gitbook. The Gitbook is still being worked on but it is useful even now. It provides much more structure than disparate markdown files in the doc/ directory.

The markdown files in the doc/ directory will gradually be replaced by the Gitbook but are retained until superceeded.