Skip to content

docs: Docs-wide link fixes and xref update - #4103

Open
jabbacakes wants to merge 5 commits into
develop-3.x.xfrom
docs/link-fixes-upport
Open

docs: Docs-wide link fixes and xref update#4103
jabbacakes wants to merge 5 commits into
develop-3.x.xfrom
docs/link-fixes-upport

Conversation

@jabbacakes

Copy link
Copy Markdown
Contributor

Purpose of this PR

Docs-wide link fixes using Claude, as well as converting all links to API members to xrefs, which is the recommended format and means they'll resolve to the version matching the one the user is already in. And a typo fix for some API docs.

Jira ticket

A bunch of feedback we just got in in the DOCMP project

Documentation

  • Includes edits to existing public manual documentation.
  • Includes edits to existing public API documentation.

Testing & QA (How your changes can be verified during release Playtest)

Built locally and checked

Up-port

Up port of #4102

Backports

N/A NGO 1.0 will be unsupported soon

@jabbacakes
jabbacakes marked this pull request as ready for review July 24, 2026 12:58
@jabbacakes
jabbacakes requested a review from a team as a code owner July 24, 2026 12:58
@jabbacakes
jabbacakes marked this pull request as draft July 24, 2026 13:03
@jabbacakes
jabbacakes marked this pull request as ready for review July 24, 2026 13:03
@@ -0,0 +1,18 @@
# Single player sessions

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.

I'm up-porting single player transport PR via #4099 (but I guess we can also leave it here if it's the same as it won't make any difference)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The only difference is the update to the link formatting

Updated documentation for INetworkSerializable to include specific references to FastBufferReader and FastBufferWriter.
@codecov-github-com

codecov-github-com Bot commented Jul 29, 2026

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

@@                Coverage Diff                @@
##           develop-3.x.x    #4103      +/-   ##
=================================================
+ Coverage          70.44%   70.45%   +0.01%     
=================================================
  Files                146      146              
  Lines              23275    23276       +1     
=================================================
+ Hits               16396    16400       +4     
+ Misses              6879     6876       -3     
Flag Coverage Δ
NGOv2_ubuntu_6000.3 70.45% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...eobjects/Runtime/Messaging/RpcTargets/RpcTarget.cs 100.00% <ø> (ø)

... and 3 files with indirect coverage changes

Components Coverage Δ
com.unity.netcode.gameobjects 70.45% <100.00%> (+0.01%) ⬆️

ℹ️ Need help interpreting these results?

@jabbacakes
jabbacakes enabled auto-merge (squash) July 29, 2026 13:40
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.

3 participants