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

Rework documentation #513

Merged
merged 7 commits into from
Mar 7, 2022
Merged

Rework documentation #513

merged 7 commits into from
Mar 7, 2022

Conversation

rubenvanerk
Copy link
Contributor

Here's my shot at a new README. We might be able to get away with putting the documentation in here, but I'm not too sure.

Related: #498

@k00ni k00ni linked an issue Feb 14, 2022 that may be closed by this pull request
@k00ni
Copy link
Collaborator

k00ni commented Feb 14, 2022

Thank you @rubenvanerk!

I took the liberty and made some changes in your branch. Hope it was OK. English is not my mother tongue so you might find instances to improve.

@Reqrefusion I moved a big chunk from the wiki into new documentation files.

Open/to discuss:

CC @likemusic

Is that the right direction?

@k00ni k00ni closed this Feb 14, 2022
@k00ni k00ni reopened this Feb 14, 2022
@k00ni k00ni changed the title Create new README Rework documentation Feb 14, 2022
@k00ni
Copy link
Collaborator

k00ni commented Feb 25, 2022

I refined some things and added latest wiki-content made by @Reqrefusion.

What is left to do here?

@Reqrefusion After this got accepted and merged I would like to remove all content from wiki and only leave a hint to our new documentation. That way there is no confusion where to find latest documentation. What do you think?

If there is anything I missed, please give me a hint.

@k00ni k00ni marked this pull request as ready for review February 25, 2022 12:44
@k00ni
Copy link
Collaborator

k00ni commented Mar 2, 2022

OK, I will leave this open until end of this week. If there are no objections or comments, this PR gets merged afterwards. Documentation is way from finished but with this work there is a good basement in my opinion, and we can continue with other PRs.

@k00ni k00ni mentioned this pull request Mar 2, 2022
@k00ni k00ni self-assigned this Mar 2, 2022
@k00ni k00ni merged commit ae82e91 into smalot:master Mar 7, 2022
@Reqrefusion
Copy link

I feel bad seeing this so late. It seems like the end of Wiki has come. One of Github's nice but insufficient features. I will still make a few changes to the config. The current config is not very descriptive. The table I created beforehand makes trial and error easier.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Updating documentation
3 participants