search

gomint / gomint-docs

The documentation source of the GoMint server software
https://docs.gomint.io
1 stars 2 forks source link

Kickstart new GoMint documentation website #1

Closed minty-bot[bot] closed 4 years ago

minty-bot[bot] commented 4 years ago

Requested by Chapl#705209280529301525.

Kickstart a new GoMint documentation website and migrate GoMint GitHub wiki content to it. There's already this website but it's old and not maintained. I'm fine with how it is looking like and how the structure is.

I'm wondering whether GitBook relies on a repository and compiles the page via markdown or if GitBook provides a fully fledged documentation editing page. There's a Wiki repository but it doesn't seem to be related to GitBook.

waltster commented 4 years ago

Hey,

I am not sure to what extent anyone is still interested in this, but if it is of interest, I can begin working with GitBook. I have published some documentation there a while ago, but Netlify and a repository on Github could also work well.

If someone can respond, that'd be great.

@chaplchapl thoughts?

geNAZt commented 4 years ago

I would love to have some kind of documentation generator so i can document in code. I guess javadocs with some custom tags (and markdown support) should be enough, just need a great design and some custom index page.

Soupertonic commented 4 years ago

I would love to have some kind of documentation generator so i can document in code. I guess javadocs with some custom tags (and markdown support) should be enough, just need a great design and some custom index page.

First we need to clarify what kind of documentation. The kind of documentation this issue is referring to is user documentation. Topics like how to get started, how to write your first plugin, what to look out for, idioms, mechanics — you name it.

If this is meant to be inside source files well there's only one thing I've got to say to this: No way José!

waltster commented 4 years ago

In that case @chaplchapl, I was looking into docusaurus.io and it looks like it would be a really easy way to host the documentation you are talking about. Netlify can build on-trigger too, so that would really streamline the entire process.

Soupertonic commented 4 years ago

Docusaurus looks really nice! I will look into this right now!

Soupertonic commented 4 years ago

Just as a heads up: I'm going to play a bit with Docusaurus (v1.0, not v2.0) and if I deem it to be good enough, I will create a new repository just for the documentation.

[...] and if I deem it to be good enough

It does look really promising from what I have seen already.

Soupertonic commented 4 years ago

image

Now, this is actually pretty sick. I have gone ahead and tried out the workflow you suggested and it is working pretty good. In a result to that, the documentation got its own repository, uses Docusaurus, is already deployed to Netlify and can be viewed here. The domain has yet to be changed but the documentation will be accessible at docs.gomint.io in a later point in time.

waltster commented 4 years ago

Awesome! I will go ahead and start drafting some documentation.

Soupertonic commented 4 years ago

Now that the documentation has been kickstarted I will close down this issue. Feel free to join the Discord server for further discussions. The new HEAD is deploying to Netlify right now. In the footer, there's a link called "Discord". It will bring you to the invite page.