Skip to content

Added Framework Compatiblity#7

Open
Tiltann wants to merge 6 commits intoSamMethot:mainfrom
Tiltann:docs/frameworks
Open

Added Framework Compatiblity#7
Tiltann wants to merge 6 commits intoSamMethot:mainfrom
Tiltann:docs/frameworks

Conversation

@Tiltann
Copy link
Copy Markdown

@Tiltann Tiltann commented May 9, 2026

Pull Request

What This Changes

This PR builds out the frameworks section by adding dedicated lessons for Qbox, ESX, and QBCore, then aligning all three so they read as one coherent track. It standardizes the plain-English framework intro, adds “what makes it different” and “who made it” sections for each framework with source links, and updates navigation so learners can move through frameworks in order without context switching.

Type Of Change

  • Typo / broken link / formatting
  • Bug fix in an example
  • Outdated API reference
  • New lesson or section
  • Improved example (clearer / shorter / more correct)
  • Other (explain below)

Other:

  • Documentation structure and cross-framework consistency improvements.

Lesson(s) Affected

  • 05-frameworks/01-qbox-basics.md
  • 05-frameworks/02-esx-basics.md
  • 05-frameworks/03-qbcore-basics.md
  • INDEX.md
  • README.md

Testing

  • I tested the code on a dev server
  • The code matches the line-by-line annotation style of the rest of the repo
  • All ? placeholders are used in SQL (no string concat)
  • Any net event examples include source caching + arg validation
  • Doc links resolve

Tone Check

  • Plain-English summary at the top of any new lesson
  • Every non-trivial Lua line is annotated
  • TL;DR section at the bottom
  • Next: pointer at the end if it is a numbered lesson
  • No filler / marketing speak / unnecessary emoji
  • Doc links go to canonical sources (FiveM docs, coxdocs.dev, docs.qbox.re)

Updated Index?

  • Updated INDEX.md if I added or renamed files
  • N/A - did not change file structure

Additional Notes

  • Qbox, ESX, and QBCore are now documented as a connected set instead of isolated references.
  • Qbox content was also adjusted so it stays consistent with the new ESX and QBCore lessons.
  • ESX includes a dedicated export-vs-event explanation and a separate collapsible legacy section for older EssentialMode-based setups.
  • Framework lesson flow now has consistent Next pointers:
    • 05-frameworks/01-qbox-basics.md -> 05-frameworks/02-esx-basics.md
    • 05-frameworks/02-esx-basics.md -> 05-frameworks/03-qbcore-basics.md
    • 05-frameworks/03-qbcore-basics.md -> 06-ox-libraries/01-ox-lib.md

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