Skip to content
This repository has been archived by the owner on Jun 2, 2024. It is now read-only.

Create doc for each of our emulators #19

Open
kdecks opened this issue Feb 8, 2019 · 9 comments
Open

Create doc for each of our emulators #19

kdecks opened this issue Feb 8, 2019 · 9 comments

Comments

@kdecks
Copy link
Contributor

kdecks commented Feb 8, 2019

No description provided.

@meleu meleu changed the title Create FAQ for each of our emulators Create doc for each of our emulators Feb 10, 2019
@meleu
Copy link
Contributor

meleu commented Feb 10, 2019

(I took the liberty to rename the title of this issue.)

I started a "blank" page for it: https://github.com/RetroAchievements/docs/wiki/RAEmus

Maybe @rzumer could add some info for RAQUASI88

@rzumer
Copy link

rzumer commented Feb 10, 2019

Done, but I am mostly redirecting to the documentation and forum, since there would be too much information and duplication of information (making it difficult to keep up to date) otherwise.

@kdecks
Copy link
Contributor Author

kdecks commented Feb 11, 2019

I way thinking about a specific page for each, but perhaps this is equal or better. I do think that wiki's tend to be better off with many shorter pages than fewer longer ones, in terms of overall design.

@meleu
Copy link
Contributor

meleu commented Feb 11, 2019

@rzumer

there would be too much information and duplication of information (making it difficult to keep up to date) otherwise.

I initially agreed, but at a 2nd thought maybe it would be better to keep the up to date information here IMO. Cause it would be easier to receive contributions and have a proper visibility (rather than being buried in the forums when that thread doesn't have activity).

I've created a dedicated page for RAQUASI88, if you agree with this approach I can generate the page for the docs tonight.

@meleu
Copy link
Contributor

meleu commented Feb 11, 2019

@kdecks I'm OK with the that approach (each emu having its own page) and started to design the sidebar menu to work like that.

I see many users having problems/doubts with RAP64 and RAMeka, could you fill some info on their respective pages?

https://github.com/RetroAchievements/docs/wiki/RAMeka
https://github.com/RetroAchievements/docs/wiki/RAP64

@rzumer
Copy link

rzumer commented Feb 11, 2019

Do what you want, but I won't maintain a page for it beyond directing to the documentation.

I know that circumstances are different with other emulators that do not have maintainers, so having more complete documentation in the wiki might be more convenient than writing documents to add to the repository, but as the maintainer of QUASI88kai/RAQUASI88 I don't want to be responsible for duplicating changes to the documentation in multiple places.

@meleu
Copy link
Contributor

meleu commented Feb 11, 2019

Do what you want, but I won't maintain a page for it beyond directing to the documentation.

Sure. The official documentation should be the "way to go". I was referring more to possible tricks that can be present in that forum topic. But if the current content is fine then it's done.

@rzumer
Copy link

rzumer commented Feb 11, 2019

I don't mind moving the tips from the forum thread to the page, then, but right now it is incomplete and disorganized.

@kdecks
Copy link
Contributor Author

kdecks commented Feb 12, 2019

All basic pages created. Not sure entirely what to put there yet.

The idea I have so far is to list setup information, FAQ, known issues, troubleshooting, unique features, hotkeys, specific to each system. If it's not obvious, these pages are intended to grow over time. I don't have all this information readily available.

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

No branches or pull requests

3 participants