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

Add a docs page explaining to players what subsets are and how to play them #94

Closed
wescopeland opened this issue Aug 26, 2024 · 5 comments · Fixed by #104
Closed

Add a docs page explaining to players what subsets are and how to play them #94

wescopeland opened this issue Aug 26, 2024 · 5 comments · Fixed by #104
Labels
help wanted Extra attention is needed kind/enhancement New feature or request where/general

Comments

@wescopeland
Copy link
Member

wescopeland commented Aug 26, 2024

"subset" is the top search query on the docs site, but it currently sends people to a developer doc. This is very much less than ideal.

@wescopeland wescopeland added kind/enhancement New feature or request help wanted Extra attention is needed where/general labels Aug 26, 2024
@SuperGamer18
Copy link
Contributor

I'm willing to do it. But first, I'm going to ask the following:
Would it be a good idea to copy portions from https://github.com/RetroAchievements/docs/blob/main/docs/guidelines/content/subsets.md this doc? Because it does have a decent amount of information players could understand (obviously I'm not asking to just copy and paste what was done here and only polish it slightly, it's more than just that).

@wescopeland
Copy link
Member Author

wescopeland commented Aug 28, 2024

@SuperGamer18 Hi!

It's probably OK to take inspiration from portions of that document, yes. However, I believe the emphasis should be most tightly focused on:

  • Very quickly explaining a subset (3 sentences most for this, maybe link to existing doc if user wants to learn more)
  • With both pictures and text, quickly explain how to take an existing ROM and patch it. Search traffic suggests this is what people are looking for and can't find.

Someone should be able to open the page and gather this info in 3 minutes or less.

If successful, we'll link the site directly to the doc.

For content that may be duplicative, it could be best to just link to that existing subsets page. We can then track if people who land on this page navigate there. Based on those behavior patterns we can continue to refine both pages.

@SuperGamer18
Copy link
Contributor

SuperGamer18 commented Aug 28, 2024

Alright, I'll proceed to work on it, thanks for the suggestions, Wes! Also one last question for now, in which directory would you think is the most suitable for putting this in? (This is the first time I make a new file for this repo btw, so I'm not sure where everything should go)

@wescopeland
Copy link
Member Author

Also one last question for now, in which directory would you think is the most suitable for putting this in?

Good question. I think probably in general/tutorials/how-to-play-subsets.md.

The sidebar can be updated in docs/.vitepress/config/en.ts. I'd put it right underneath the tutorial for PSP DLC:

{
  text: "Working with DLC for the PlayStation Portable",
  link: "/general/tutorials/working-with-dlc-for-the-psp",
},
{
  text: "How to Play Subsets",
  link: "/general/tutorials/how-to-play-subsets",
},

@SuperGamer18
Copy link
Contributor

SuperGamer18 commented Sep 2, 2024

Just made a PR about this, it's #104. As usual, feel free to hit me up with some suggestions (nothing about replacing the screenshots though, sorry).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed kind/enhancement New feature or request where/general
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants