Skip to content

Update developer doc examples and update outdated toolkit screenshots#396

Merged
wescopeland merged 21 commits into
RetroAchievements:mainfrom
pilzkopf777:pilzkopf/dev-doc-rework
Jul 11, 2026
Merged

Update developer doc examples and update outdated toolkit screenshots#396
wescopeland merged 21 commits into
RetroAchievements:mainfrom
pilzkopf777:pilzkopf/dev-doc-rework

Conversation

@pilzkopf777

@pilzkopf777 pilzkopf777 commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Proposing update to the developer documentation. Quick overview of what's involved:

  • Updated Code Note examples to better suit the newly decided standards.
  • Toolkit screenshots were quite outdated - swapped out accordingly.
  • Guide for Getting Started updated as well as the currently example is out of date.
  • Updated guide based on achievement for Leaderboards.
  • Also added notes on how and when to implement Instant Submission LBs which was missing previously.
  • Some pages like ResetIf feature an example on usage.

Comment thread docs/guidelines/content/code-notes.md Outdated
Comment thread docs/guidelines/content/code-notes.md Outdated
Comment thread docs/guidelines/content/code-notes.md Outdated
Comment thread docs/developer-docs/leaderboards.md
Comment thread docs/developer-docs/leaderboards.md Outdated
Comment thread docs/guidelines/content/code-notes.md
Comment thread docs/guidelines/content/code-notes.md
Comment thread docs/guidelines/content/code-notes.md Outdated
Comment thread docs/developer-docs/flags/resetif.md Outdated
Comment thread docs/public/new-editor-overview.png
@suspect15

Copy link
Copy Markdown
Contributor

This is a really helpful update. Thank you for doing this!

@pilzkopf777

Copy link
Copy Markdown
Contributor Author

@redwizard42

Copy link
Copy Markdown
Contributor

How are we all feeling about moving the example from the Real Examples section of the docs to the respective guides on flags?

I have debated this with myself a lot. I think having more examples in the flags docs themselves is a good thing to do (I made sure I had a few examples of use for Remember/Recall), but I think there's benefit in having the real examples as their own thing as a sort of "I have this task/goal, how do I code that?"

Both of these have merit and should be represented:

Examples in Flags docs: "What can I do with this flag?"
Examples of Tasks: "What flags and features do I need to do this kind of thing?"

@pilzkopf777

Copy link
Copy Markdown
Contributor Author

How are we all feeling about moving the example from the Real Examples section of the docs to the respective guides on flags?

I have debated this with myself a lot. I think having more examples in the flags docs themselves is a good thing to do (I made sure I had a few examples of use for Remember/Recall), but I think there's benefit in having the real examples as their own thing as a sort of "I have this task/goal, how do I code that?"

Both of these have merit and should be represented:

Examples in Flags docs: "What can I do with this flag?" Examples of Tasks: "What flags and features do I need to do this kind of thing?"

Based on some other Jrs and how they navigated the docs I rarely saw them consult the "real examples" section as such. Never did they think "oh, is this case covered" but instead asked in the Discord chat and then navigated to the specifics about a flag in the docs.

@pilzkopf777 pilzkopf777 marked this pull request as ready for review July 11, 2026 00:59
@pilzkopf777 pilzkopf777 requested a review from Jamiras July 11, 2026 00:59
@greptile-apps

greptile-apps Bot commented Jul 11, 2026

Copy link
Copy Markdown

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed code.

Reviews (2): Last reviewed commit: "typo fixes reported by linter" | Re-trigger Greptile

Comment thread docs/developer-docs/leaderboards.md Outdated
Comment thread docs/developer-docs/leaderboards.md Outdated
Comment thread docs/developer-docs/leaderboards.md Outdated
Comment thread docs/guidelines/content/code-notes.md Outdated
@wescopeland wescopeland merged commit 6226ebf into RetroAchievements:main Jul 11, 2026
2 checks passed
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.

6 participants