Options for adding user guide to repository

Jonathan Gibbons jonathan.gibbons at oracle.com
Wed May 12 20:23:59 UTC 2021

There's an OpenJDK wiki that could be used to host documentation.

-- Jon

On 5/12/21 11:11 AM, Liam Wynn wrote:
> Hi all,
> I had a chance to go through an old user guide that Leonid sent me. The
> goal is to update that to be suitable for the latest version of asmtools. I
> was wondering: what do you all think would be the best way to include
> documentation?
> The most straight-forward way of doing it would be to include, say a "docs"
> folder. On the other hand, Github itself offers some great options for
> adding documentation to the repository itself: it allows you to create a
> wiki for it. It's nice and easily accessible, but on the other hand it does
> tie the repo to Github a bit. If migrating to another service like
> BitBucket or was an issue, then using Github-specific features like the
> wiki would be an issue.
> Let me know what you think.
> - Liam

More information about the asmtools-dev mailing list