search

aeternity / aesophia

Stand alone compiler for the Sophia smart contract language
https://docs.aeternity.com/aesophia
ISC License
51 stars 19 forks source link

Feature/mkdocs with versioning #333

Closed marc0olo closed 3 years ago

marc0olo commented 3 years ago

I added mkdocs and restructured the docs and readme accordingly. I hope this is fine. It also introduces versioning of the docs and the respective github action will always set the docs of the latest release as default.

Preview of the generated mkdocs is available here:

=> Of course this can be previewed locally by e.g. executing mkdocs serve

After this has been merged somebody with access to the repo should execute following commands to set an initial alias for the master branch to latest and make latest the default version to be published:

mike alias master latest --push
mike set-default latest --push

If this is done the docs should be served at https://aeternity.com/aesophia

I am open for any suggestions and looking forward to the comments.

marc0olo commented 3 years ago

@hanssv @radrow please, if you find some time 🙏

marc0olo commented 3 years ago

Looks good to me, make sure no changes in sophia.md are lost in the process (if it changes before this PR is merged).

will do so! I accepted your suggestion and added another commit to fix the anchors in the stdlib. can you approve again? :-)

and I need another approval - @radrow maybe? :D

marc0olo commented 3 years ago

yeehaw 😄

who wants to merge?

please keep in mind that somebody with access also needs to execute the following commands in the .docssite folder after the merge:

mike alias master latest --push
mike set-default latest --push

read more mike here: https://github.com/jimporter/mike

after that the github actions should do the rest of the work. it's mainly about setting the initial default alias which doesn't exist yet.