Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

docs at the website #2117

Closed
MeztliRA opened this issue Apr 18, 2021 · 20 comments
Closed

docs at the website #2117

MeztliRA opened this issue Apr 18, 2021 · 20 comments
Labels
enhancement New feature or request

Comments

@MeztliRA
Copy link
Contributor

Is your feature request related to a problem? Please describe.
there should be documentation at the website

Describe the solution you'd like
add documentation maybe at dogehouse.tv/docs

when theres a public api theres should be documentation for it to at the website

Describe alternatives you've considered
none

Additional context

@MeztliRA MeztliRA added the enhancement New feature or request label Apr 18, 2021
@dk-raw
Copy link
Contributor

dk-raw commented Apr 18, 2021

Documentation for what? Contributing? If that's the case, there is no need for documentation on how to contribute on the main website.

@TheOtterlord
Copy link
Contributor

I believe they mean this:

when theres a public api theres should be documentation for it to at the website

so possibly for the endpoints/kebab

@MeztliRA
Copy link
Contributor Author

Documentation for what? Contributing? If that's the case, there is no need for documentation on how to contribute on the main website.

for the site, and also when theres a public api maybe also for that to

@dk-raw
Copy link
Contributor

dk-raw commented Apr 18, 2021

I personally think that GitHub is more suited for API docs

@TheOtterlord
Copy link
Contributor

TheOtterlord commented Apr 18, 2021

I think the only reason for a documentation site would be for usage docs. the rest can exist on github

@dk-raw
Copy link
Contributor

dk-raw commented Apr 18, 2021

I don't think we need usage docs. DogeHouse is very simple to use and understand.

@violetcrein
Copy link
Contributor

it is

@violetcrein
Copy link
Contributor

but a guide can be helpful if someone has a problem

@dk-raw
Copy link
Contributor

dk-raw commented Apr 18, 2021

We could have something like popups over each button to explain how it works, but those are very very annoying.

@violetcrein
Copy link
Contributor

i think more of a help section in the settings

@violetcrein
Copy link
Contributor

or a page like the github usage docs

@violetcrein
Copy link
Contributor

but we can display the popups when the user hovers over the button

@dk-raw
Copy link
Contributor

dk-raw commented Apr 18, 2021

but we can display the popups when the user hovers over the button

No popups, they can be quite annoying. A help section would be muck more elegant and suited.

@dk-raw
Copy link
Contributor

dk-raw commented Apr 18, 2021

I will open a discussion for this => #2120

@violetcrein
Copy link
Contributor

but we can display the popups when the user hovers over the button

No popups, they can be quite annoying. A help section would be muck more elegant and suited.

i agree

@samarmohan
Copy link
Contributor

But no one is going to go to dogehouse.tv just to see some public api docs. We can have a pop up that tells people they can contribute.

@BronzW
Copy link
Contributor

BronzW commented Apr 18, 2021

It's not a developers platform

@dk-raw
Copy link
Contributor

dk-raw commented Apr 18, 2021

But no one is going to go to dogehouse.tv just to see some public api docs. We can have a pop up that tells people they can contribute.

No pop ups, something like a discrete button where the log out button is located.

@samarmohan
Copy link
Contributor

I meant an alert oof something, but that seems nice. The current GitHub button is tiny.

maybe when you click your profile the GH link shows under the discord one.

@dk-raw
Copy link
Contributor

dk-raw commented Apr 18, 2021

It's fine as it is, only as tiny percentage of users are actually willing to and know how to contribute.

@dk-raw dk-raw closed this as completed Apr 18, 2021
Repository owner locked and limited conversation to collaborators Apr 19, 2021

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants