search

dtr-org / unit-e-project

Unit-e project information
MIT License
13 stars 4 forks source link

WIP: Prototypes for documentation site #50

Closed cornelius closed 6 years ago

cornelius commented 6 years ago

These are quick prototypes for a UnitE documentation site. One with Sphinx, one with Jekyll, both importing some content from bitcoin.org via clonemachine.

This is not meant for merging, just for collecting some feedback.

Details are in the README.md

cornelius commented 6 years ago

Just to clarify, this pull request is not meant to sort out the content but to decide on an approach for doing the documentation, which system to use, and whether it's a good idea to import upstream docs.

thothd commented 6 years ago

My tendency is to go with Sphinx, mostly due to good past experience. Ethereum are using it by way (https://github.com/ethereum/homestead-guide).

Also since we aren't restricted to use something like Jekyll since I also agree we shouldn't "fork" bitcoin's documentation but import what's needed (while keeping the correct license attribution)

cornelius commented 6 years ago

Let's go with Sphinx for now. I'll import some more content to get a more complete picture.

I'll close this pull request but keep the branch around for later reference and create a new issue to keep track of the next steps.