Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add wiki documentation #11

Open
matshou opened this issue May 1, 2020 · 8 comments
Open

Add wiki documentation #11

matshou opened this issue May 1, 2020 · 8 comments
Labels
documentation Improvements or additions to documentation

Comments

@matshou
Copy link
Member

matshou commented May 1, 2020

We should start documenting all mod mechanics in the repository wiki.

@matshou matshou added the documentation Improvements or additions to documentation label May 1, 2020
@matshou matshou assigned ghost May 1, 2020
@matshou
Copy link
Member Author

matshou commented May 1, 2020

@Titus-Armillius I think this is a good task for you to do on a continuous basis as we are discussing things and slowly implementing them. Read more about Github wikis if you are not familiar with them.

@ghost
Copy link

ghost commented May 1, 2020

@yooksi I've looked at a few tutorials and the Github documentation, but could not find much information on why the 'wiki' tab in the repository is not visible for me.

What I could find suggested that the creator of the repository might need to change some visibility setting.

Could you take a look?

@matshou
Copy link
Member Author

matshou commented May 1, 2020

Upgrade or make this repository public to enable Wikis

GitHub Wikis is a simple way to let others contribute content. Any GitHub user can create and edit pages to use for documentation, examples, support, or anything you wish.

Apparently we need to make the repository public to enable the wiki feature. I didn't know about this since I've only recently started working with private repositories, I tend to keep my code public.

Do you have any objections to us opening up the repository to the public?

@ghost
Copy link

ghost commented May 1, 2020

I'm fine with it.

@matshou
Copy link
Member Author

matshou commented May 1, 2020

Done, the wiki tab should now be visible.

@matshou
Copy link
Member Author

matshou commented May 5, 2020

@Titus-Armillius Could we get the day/night cycle documentation up on the wiki now that we've implemented that mechanic in our first pre-release?

@ghost
Copy link

ghost commented May 6, 2020

@yooksi I'll add the day/night cycle documentation asap.

Just to be sure; is the number value in the config a multiple? e.g. -12 = 12x slower?

@matshou
Copy link
Member Author

matshou commented May 6, 2020

Yes, that is correct. See TimeCycle javadoc for more information.

@ghost ghost changed the title Document mod mechanics in wiki Add wiki documentation Jun 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant