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

New Thumbnail Contrib How-To Guide, and phrasing/format revisions #1015

Merged
merged 9 commits into from
Jan 3, 2025

Conversation

OctopusButtons
Copy link
Contributor

@OctopusButtons OctopusButtons commented Jan 3, 2025

Added detailed how-to guide for Contributing Thumbnails. Guide has been iterated, tested, and successfully-recruity-of-at-least-one-new-thumbnailer in a separate forum. Revised, proofread. (I'm the original author.)

Also revised other sections of Playlists and Thumbnails page:

  • Custom Thumbnails. Heavy revision/formatting, with an eye toward expanding some lines for full-lucid-understanding but while also condensing and removing some redundancy
  • Added Anchor links for "see below" "see above" references, in cases where there's a header to link. (I skipped cases where referenced bit isn't worth a header expanding the TOC on final site.)
  • "Game Name" terminology clarification bubble and edits to game name passages
  • More specific walkthrough explanation of Flexible Name Match Algorithm
  • Edited phrasing and formatting for Custom Logos/Icons in a way that should help understanding and maybe SEO. (The synonym "icons", since the original idea may be for logos but people wondering about customizing this part of interface will probably search for "icons".)

Since the page is combined "Playlists and Thumbnails", and is large, we're probably due to separate into 2 pages. I see the site map doc structure here and will work on the division later as well as a new Database docs page.

Related Items to Come: - Connections between the new Thumbnail Contribution How-To and the thumbnail repository Readme

  • I will PR to add a set of screenshotting guidelines to the thumbnail repository ReadMe rather than to the User Guide Docs. Reasoning: people who don't need a "Users"-centric doc guide for the github process will still most likely look at the repository ReadMe when contributing.
  • Will also PR text/link for the ReadMe to direct people to the Contribution How-To in user docs, after (if) this PR gets approved and I verify the final page is live and AOK for outside linking.
  • The doc guide in this PR already references reading all rules in the thumbnail repository readme.

- Clarified phrasing on custom thumbnails and naming, e.g. matching thumbnail to displayed game name rather than "according to RA naming convention" etc per se.
- Combined some redundancy wording and examples of thumbnail subfolder setup. 
- Minor bold/format changes to Thumbnail Update methods
- New guide section added for how users can contribute thumbnails to the github repository. (We probably want to split "Thumbnails" into separate page from Playlists at this point.) The guide has been tested and iterated and proven outside of this docs/github update (on reddit) and has created new thumbnail contributors.
- Custom Thumbnail section: more revisions and re-phrasings and hierarchy and elegance (I hope) for readers
- Named Logos section, revised wording so that the meaning is clearer, and clarified format references/alignment to thumbnail guide
WIP updates to Thumbnail Contribution guide and also phrasing about custom thumbnails and custom icon/logos.
WIP revisions to Custom Thumbnails & Contrib guide
and more edits to Custom Thumbnails etc phrasing, bullets, etc.
Also more small revisions to Custom Thumbnails
And more small edits.  Except now I'm wondering about a disaster: is markdown viewable on the final libretro docs page/site, or is the markdown only correctly viewable on github itself?  Hopefully what I saw is a false alarm.
@fpscan fpscan merged commit 6b2c301 into libretro:master Jan 3, 2025
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

Successfully merging this pull request may close these issues.

2 participants