Comments (8)
Will do! Thanks for this!
Give me a day or two, kinda busy with exams at the moment.
from diohub.
To resolve this, do:
-
Add a wiki in the wiki tab.
-
Clone it by typing
git clone https://github.com/NamanShergill/diohub.wiki.git
-
Remove all existing files by typing
git clone https://github.com/lasersPew/diohub.wiki.git
-
Then
git add . && git commit -m "Initialized the wiki
-
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:
Add a wiki in the wiki tab.
Clone it by typing
git clone https://github.com/NamanShergill/diohub.wiki.git
Remove all existing files by typing
git clone https://github.com/lasersPew/diohub.wiki.git
Then
git add . && git commit -m "Initialized the wiki"
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:
- 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.
- 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:
- A general overview of the app with download links and information
- A comprehensive list of features with images/gifs
- The app changelog
- 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.
Related Issues (20)
- Add Dynamic Themes and Material You Support
- Redesign UI to have less white space HOT 5
- Add localisation support HOT 3
- Add Issue Templates to the repository
- System font does not follow miui system font HOT 4
- Ability to Delete Repositories HOT 4
- Discussion Tab should be Focused by Default in Issues HOT 3
- provide iOS .ipa HOT 1
- New update HOT 1
- Issues when network is unavailable HOT 8
- 可以增加其他语言吗,比如中文 HOT 8
- Organization - Missing information HOT 1
- how to add file on repo HOT 1
- Themes? HOT 2
- F-droid maybe?
- Readme bug
- release and star HOT 3
- Reccomendations of other repos HOT 1
- Folders before Files
- Support downloading files
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from diohub.