search

dtr-org / unit-e-project

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

WIP: Add prototype of documentation site #62

Closed cornelius closed 5 years ago

cornelius commented 6 years ago

This is a refined version of the first prototypes. It's using Sphinx and has more content. It's still a pretty raw import and needs more cleanup and additional processing.

This is mostly FYI.

Changes:

cornelius commented 5 years ago

@scravy Thanks for the comments. This is very useful input. There certainly is still a lot more to adapt. We'll have to go through the docs and make sure they match our implementation at some point. For now I'm focusing on getting the infrastructure in place, so I'll defer the changes to the docs to a later set of commits.

cornelius commented 5 years ago

The import of the bitcoin.org documentation is now in a clean state. All relevant technical content has been imported and names adjusted to Unit-e. There certainly still is a lot of inaccurate content as it doesn't apply to Unit-e in the same way as to Bitcoin. No editing has happened yet.

I would appreciate feedback if this in general looks good, the tooling, the rough structure, the content (taking into account that it still needs to be edited).

The next step would then be to identify which content needs to be changed and adjust it to Unit-e.

scravy commented 5 years ago

Where does this originally come from BTW?

cornelius commented 5 years ago

Where does this originally come from BTW?

The documentation is taken from the sources of https://bitcoin.org, ran through some custom code calling the bitcoin.org Jekyll plugins and pandoc to convert it to reStructuredText. Then clonemachine is substituting Bitcoin names with Unit-e ones, and Sphinx is creating HTML from it.

scravy commented 5 years ago

Where are these sources located?

cornelius commented 5 years ago

Where are these sources located?

https://github.com/bitcoin-dot-org/bitcoin.org

scravy commented 5 years ago

I see a transifex directory (.tx) in there, so this is also subject to translation?

cornelius commented 5 years ago

I'm not sure we want to translate any of the technical documentation we imported. That is not translated on bitcoin.org either.

We do want to translate more user-facing documentation but that probably will mostly be new material. And we can then use the support we get from Sphinx for translating stuff. Could still be done through Transifex, of course.

scravy commented 5 years ago

This is such a huge beast, it's almost impossible to review, and some of the things which I commented on are not subject to review as this things needs a whole big do-over anyway to reflect the mechanics of unit-e.

Could you list a few files / aspect you wish review on?

How do we track in the future what has been audited for unit-e already and what not? Should we maybe not have a full copy at first and only add bits as we audit them?

cornelius commented 5 years ago

At the moment I'm not looking for review of the content but for any feedback on the structure or other general comments.

I will try to come up with a way how to break down the work to review the content in more manageable pieces.

mergeable[bot] commented 5 years ago

There has not been any activity in the past 10 days. Is this still active?

cornelius commented 5 years ago

Moved over to https://github.com/dtr-org/docs.unit-e.io/pull/5. Closing this one.