Skip to content

docs: update technical documentation and API reference - #23

Merged
protheeuz merged 1 commit into
mainfrom
docs/update-technical-guides
May 25, 2026
Merged

docs: update technical documentation and API reference#23
protheeuz merged 1 commit into
mainfrom
docs/update-technical-guides

Conversation

@suckserberg

Copy link
Copy Markdown
Collaborator

Pull Request

Summary

Updates the technical documentation, API references, and benchmark data. It aligns the guide texts with the current allocation-aware send path and clarifies the distinction between public runtime defaults and benchmark profiles.

Technical Implementation

  • Updates README.md with current normalized Stats.DataSendKbps values.
  • Documents the benchmark default profile as reliableThreshold = 60000, maxPacketsPerFrame = 20.
  • Keeps public runtime defaults separate (maxPacketsPerFrame = 0).
  • Updates development-patterns.md to clarify the "allocation-aware send path" (public callbacks receive tables).
  • Integrates the latest raw JSON results into benchmark/Benchmarks.md.

Changelog Entry

  • Documentation: Update API reference and technical guides to reflect allocation-aware dispatch.

Type of Change

  • Feature
  • Bug Fix
  • Performance Optimization
  • Documentation Update
  • Maintenance / Chore

Verification and Standards

  • I have adhered to the Development Patterns.
  • I have verified that all CI/CD linting and formatting checks pass.
  • I have confirmed the changes within a Rojo-supported environment.
  • I have updated the technical documentation for any API or architectural changes.

@suckserberg
suckserberg requested a review from protheeuz as a code owner May 25, 2026 11:10
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 25, 2026

@protheeuz protheeuz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good for me, this should we update version in main branch to #README.md 💯

@protheeuz
protheeuz merged commit 82763be into main May 25, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants