Adding a new wiki to declutter the README.md about diohub HOT 8 OPEN

Will do! Thanks for this!

Give me a day or two, kinda busy with exams at the moment.

from diohub.

To resolve this, do:

1. Add a wiki in the wiki tab.

2. Clone it by typinggit clone https://github.com/NamanShergill/diohub.wiki.git

3. Remove all existing files by typing git clone https://github.com/lasersPew/diohub.wiki.git

4. Then git add . && git commit -m "Initialized the wiki

5. Then git push

There's no way you could do this on the GitHub site nor the GitHub app. Wiki cloning only works on the CLI.

from diohub.

Sorry for the delay, it's been a hectic few weeks. I'll get this up as soon as I am able to!

from diohub.

To resolve this, do:

1. Add a wiki in the wiki tab.

2. Clone it by typinggit clone https://github.com/NamanShergill/diohub.wiki.git

3. Remove all existing files by typing git clone https://github.com/lasersPew/diohub.wiki.git

4. Then git add . && git commit -m "Initialized the wiki"

5. Then git push

There's no way you could do this on the GitHub site nor the GitHub app. Wiki cloning only works on the CLI.

Edit: before you git add, you can remove .GitHub folder by typing rmdir .github

from diohub.

Might move this content to a dedicated repository or a sub directory, instead of a wiki

The reason: GitHub has no API to fetch the wiki of a repository, hence, the app can only do two things:

1. Render the wiki in a webview and strip away all the surrounding components from the webpage. This is inconsistent and would break the UI if github changes any component names of the surrounding UI. Also, only works on public repositories, trying to access wikis from private repositories would probably never work this way.
2. The app opens it in the in app browser. This is by far, the cleanest approach

However, neither are as clean as I think they should be for including important information about the app itself in them. Not a big deal with option 2 however, but I don’t think the app would have that much information to need a wiki.

Off the top of my head, I can think of this information that need dedicated readme files:

1. A general overview of the app with download links and information
2. A comprehensive list of features with images/gifs
3. The app changelog
4. The roadmap (probably better to put that here than have an issue tracking it, like #41). Much easier to update.

Even if we add a couple more, it’s not a lot. The current readme does need to be decluttered though.

from diohub.

Might move this content to a dedicated repository or a sub directory, instead of a wiki

The reason: GitHub has no API to fetch the wiki of a repository, hence, the app can only do two things:

1. Render the wiki in a webview and strip away all the surrounding components from the webpage. This is inconsistent and would break the UI if github changes any component names of the surrounding UI. Also, only works on public repositories, trying to access wikis from private repositories would probably never work this way.

2. The app opens it in the in app browser. This is by far, the cleanest approach

However, neither are as clean as I think they should be for including important information about the app itself in them. Not a big deal with option 2 however, but I don’t think the app would have that much information to need a wiki.

Off the top of my head, I can think of this information that need dedicated readme files:

1. A general overview of the app with download links and information

2. A comprehensive list of features with images/gifs

3. The app changelog

4. The roadmap (probably better to put that here than have an issue tracking it, like [Roadmap #41](https://github.com/NamanShergill/diohub/issues/41)). Much easier to update.

Even if we add a couple more, it’s not a lot. The current readme does need to be decluttered though.

How about a whole website like Tachiyomi

from diohub.

Heh it’s tempting, but there won’t be enough content as I mentioned, 4 pages at most.

It’s not a library so there’s not much to document to explain the inner workings to the user

from diohub.

well, atleast it features the app itself.

from diohub.