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

Move wiki to the website? #2

Open
Snailedlt opened this issue Oct 25, 2023 · 5 comments
Open

Move wiki to the website? #2

Snailedlt opened this issue Oct 25, 2023 · 5 comments

Comments

@Snailedlt
Copy link

Currently our wiki is on the main repo's wiki tab on GitHub.
Sadly the wiki is only updatable by the maintianers... And AFAIK it's not possible to create PR'S to change it. Before we used the wiki, we had a README.md file... But that quickly got too long to be easily readable.

I suggest we add a wiki route to the new website. This will allow contributors to easily contribute to the wiki as well.
If we make it with a markdown we can pretty much just copy the entire wiki. It would also be easier for contributors to edit markdown than HTML, so this is probbaly the way to go.
Here's a library we might be able to use: https://www.npmjs.com/package/ngx-markdown.

@uncenter
Copy link

I think you can make wikis editable by anyone, just like Wikipedia. No PRs needed which is interesting but moderators can easily revert changes. For example, https://github.com/helix-editor/helix/wiki.

@Snailedlt
Copy link
Author

I don't like the idea of having wikis editable and publishable by anyone. If they can create PRs then it should be fine... But if anyone can edit the wiki we pretty much guarantee that trolls will take it over eventually

@uncenter
Copy link

That's what I thought at first but I mean Helix has over 3 times as many stars as the main Devicon repository.

@Snailedlt
Copy link
Author

@uncenter I see your point, but I don't think they should be doing it either 😅

@uncenter
Copy link

uncenter commented Oct 28, 2023

@uncenter I see your point, but I don't think they should be doing it either 😅

😅 That's what I said to them too! I think they have the advantage of more (and more active) maintainers which makes it easier to prevent abuse.

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

No branches or pull requests

2 participants