Feature/mkdocs with versioning #824

2021-07-27T23:32:40+09:00

zxq9 commented

2021-07-27 23:32:40 +09:00

(Migrated from gitlab.com)

Created by: marc0olo

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:

https://marc0olo.github.io/aesophia

=> 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.

*Created by: marc0olo* 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: - https://marc0olo.github.io/aesophia => 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.

zxq9 commented

2021-08-19 05:05:04 +09:00

(Migrated from gitlab.com)

Created by: marc0olo

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

*Created by: marc0olo* @hanssv @radrow please, if you find some time 🙏

zxq9 commented

2021-08-20 14:48:27 +09:00

(Migrated from gitlab.com)

Created by: hanssv

Sophia is a functional language designed for smart contract development. It is strongly typed and has

*Created by: hanssv* ```suggestion:-0+0 Sophia is a functional language designed for smart contract development. It is strongly typed and has ```

zxq9 commented

2021-08-20 14:49:58 +09:00

(Migrated from gitlab.com)

Created by: hanssv

If you know ML (or another language in its family) you will recognize some syntax regardless, and if you don't, the "ML family" isn't going to provide you any insight 😅

*Created by: hanssv* If you know ML (or another language in its family) you will recognize some syntax regardless, and if you don't, the "ML family" isn't going to provide you any insight 😅

zxq9 commented

2021-08-20 14:52:41 +09:00

(Migrated from gitlab.com)

Created by: hanssv

Review: Dismissed

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

*Created by: hanssv* **Review:** Dismissed Looks good to me, make sure no changes in `sophia.md` are lost in the process (if it changes before this PR is merged).

zxq9 commented

2021-08-20 16:59:21 +09:00

(Migrated from gitlab.com)

Created by: marc0olo

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

*Created by: marc0olo* > 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

zxq9 commented

2021-08-20 17:03:14 +09:00

(Migrated from gitlab.com)

Created by: radrow

Review: Approved

Looks good

*Created by: radrow* **Review:** Approved Looks good

zxq9 commented

2021-08-20 18:37:00 +09:00

(Migrated from gitlab.com)

Created by: hanssv

Review: Approved

*Created by: hanssv* **Review:** Approved

zxq9 commented

2021-08-20 21:29:02 +09:00

(Migrated from gitlab.com)

Created by: marc0olo

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.

*Created by: marc0olo* 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.

zxq9 commented

2021-08-27 23:46:18 +09:00

(Migrated from gitlab.com)

Merged by: dincho at 2021-08-27 14:46:18 UTC

*Merged by: dincho at 2021-08-27 14:46:18 UTC*

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: QPQ-AG/sophia#824