search

aeternity / protocol

Specification of the æternity blockchain protocol
https://docs.aeternity.com/protocol
208 stars 76 forks source link

docs: restructuring & introduction of mkdocs #494

Closed marc0olo closed 3 years ago

marc0olo commented 3 years ago

the current state can be viewed here: https://marc0olo.github.io/protocol/

I made some restructuring and added mkdocs to finally be able to find what somebody needs more easily.

I also noticed parts that definitely need to be reviewed again as they aren't really accurate any longer. but this should be done separately IMO.

this PR focuses on providing a guided and clickable structure for the protocol.

when this is merged a github action should automatically deploy the docs which should then be accesible at https://aeternity.com/protocol/

dincho commented 3 years ago

What's the intention behind moving everything in a subdir ? While I agree it might look better from code perspective, unfortunately this is major BC break and I bet a lot of back-links will be broken after that. Also there are 14 pull requests here that this will create conflicts for.

So I'd suggest keeping the old file location for now at least.

marc0olo commented 3 years ago

What's the intention behind moving everything in a subdir ? While I agree it might look better from code perspective, unfortunately this is major BC break and I bet a lot of back-links will be broken after that. Also there are 14 pull requests here that this will create conflicts for.

So I'd suggest keeping the old file location for now at least.

I generally agree. not 100% sure anymore why I did that. will try to handle this via the simple-hook.

independently I changed some structure and renamed index files in subfolders to README.md. should we also try to keep the filenames wherever possible? just wondering

marc0olo commented 3 years ago

now using the old structure again. there are still some changes (e.g. sync folder and the renaming of the entrypoint markdowns to README.md)

can we keep that or should I revert that, too?

marc0olo commented 3 years ago

improved the docs structure. using a separate .docssite folder now for the mkdocs stuff

dincho commented 3 years ago

I'd suggest keeping the old file name as well and point it with link to the new index file (aka README.md)