Skip to content

Overhaul API docs + add v30 release notes (2026 Wikithon edits)#560

Open
AtilioA wants to merge 5 commits intoNorbyte:mainfrom
AtilioA:2026-wikithon-edits
Open

Overhaul API docs + add v30 release notes (2026 Wikithon edits)#560
AtilioA wants to merge 5 commits intoNorbyte:mainfrom
AtilioA:2026-wikithon-edits

Conversation

@AtilioA
Copy link
Contributor

@AtilioA AtilioA commented Feb 12, 2026

These are my contributions to the SE documentation as part of the 2026 CMTY Wikithon; this PR:

  • Overhauls Docs/API.md with a large docs pass focused on clarity, structure, and content:
    • Fixed Markdown hierarchy;
    • Updated ToC;
    • Added new Persistence section, collapsed deprecated PersistentVars section content in favor of UserVars and ModVars;
    • Slightly clarified NetChannels API example usage;
    • Improved module documentation:
      • Improved/expanded UI, Mod, Utils sections, also clarified Timer usage;
      • Documented Loca, StaticData, Resource, Template, IO;
      • Added initial stubs for some undocumented sections such as Audio, Level, etc;
      • Minor fixes or clarifications such as correcting Ext.Utils.MonotonicTime, GetModInfo, etc.
  • Adds v30 changelog content to ReleaseNotes.md. Note that v29 is still missing as I couldn't find those changelogs.

- Fixed markdown hierarchy
- Updated ToC
- Added section for Persistence, collapsed PersistentVars section in favor of UserVars and ModVars
- Added initial sections and to-dos for Audio, Levels and other missing sections
- Reorganized Math and Engine Events into tables
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.

1 participant