While Github works well for publishing results it is a bit cumbersome to work with when used for authoring and collaborative editing. Here projects like Google Docs are often used but Google Docs lacks decent support for syntax highlighting and doesn't make it easy when it comes to exporting in a way that works well with code related tooling (wikis, IDEs, …).

Nextjournal provides a simple ui for authoring of documents that can also include source code and allows for export as Markdown (compatible with Github).

Here is an example of how this looks like on Nextjournal:

(n.b.: Nextjournal currently doesn't support syntax highlighting specific to the Solidity programming language but it is similar enough to JavaScript that it worked better than expected)

We encourage you to give Nextjournal a try for documentation and authoring. It also is a great platform for literate programming in general.