Documentation is closed for contributions

[mdlsvensson]

I would like to contribute to the documentation, but I am currently not able to as it's closed. GitHub wikis are weird as I remember they don't work via pull requests? Maybe a public wiki is a pain, hence I've never seen one in the wild.

Humble suggestions for this:

• Make the wiki publicly editable, or
• do documentation via github pages. For example: like Wurst, or w3ts

[Orden4]

It seems that at present the only way to allow people without write access to your repository to contribute is to open it to literally anyone, which I'm not that keen on. Given that, there's only 2 real ways to go about this (other than opening a ticket and having me handle whatever change you want to make... which would get exhausting for me very quickly).

1. I make a new repo with the wiki pages on it, then change the origin of WCSharp's wiki page to that so I can pull changes on that repo into WCSharp's wiki.
2. We go for the github pages route, but in this case you're probably kind of on your own? If you're familiar with them and would like to try your hand at making one, then by all means, go for it.

[mdlsvensson]

It seems that at present the only way to allow people without write access to your repository to contribute is to open it to literally anyone, which I'm not that keen on.

That how I recalled it as well. And definitely agree, that seems either bad or a unnecessary workload for you.

We go for the github pages route, but in this case you're probably kind of on your own? If you're familiar with them and would like to try your hand at making one, then by all means, go for it.

I'll look into this and set it up in my fork. If you have a preference between docusaurus or mkdocs (or something else), let me know.

[Orden4]

Docusaurus looks a bit cleaner to me, but I'm fine with either option.

[mdlsvensson]

I've been working at it and I've merged the current wiki to mkdocs implementation here. It's under WCSharp. I'm pretty sure I've fixed all the broken links and formatting, etc. Still needs a lot of work.

Included is also some work I've been doing on rewrites, which is under Getting Started.

I started with Docusaurus, because it looked cleaner just like you said. But I found material for mkdocs, which is similar to Docusaurus. Other reasons I think mkdocs is preferable is that it's not React based (easier to maintain for different people), and it has client-side search, while docusaurus recommends third party crawlers for search.

There's also github actions workflow here for auto deploy on push to main.

[mdlsvensson]

Also, I've found the best way to set this up is to have a separate repo for the docs.

The actions script deploys everything pushed to the main branch to the gh-pages branch. So whenever the implementation is ready, you just create a new repo for the docs and I push upstream.