search

RiptideNetworking / Riptide

Lightweight C# networking solution for multiplayer games.
https://riptide.tomweiland.net
MIT License
1.04k stars 141 forks source link

Docs fail to display code references #114

Closed Pikanchion closed 6 months ago

Pikanchion commented 9 months ago

Code references to primitive types fail to display in the Docs: <see cref="byte"/>, <see cref="ushort"/>, etc.

For instance: Message.AddByte reads /// <summary>Adds a single <see cref="byte"/> to the message.</summary>, but the corresponding Docs page instead displays

Adds a single to the message.

It seems internal references display as intended, such as the /// <summary>The send mode of a <see cref="Message"/>.</summary> on line 14 of the same file and its relevant page, which correctly reads

The send mode of a Message.

tom-weiland commented 9 months ago

What's very strange is that when I build the documentation locally, it doesn't have this issue...

I don't think I made any changes to the docs (which would affect this) since the last time the site was updated. Either I'm mistaken or something works differently when building the docs locally compared to the workflow that builds the public site 🤔

Either way, I guess we won't find out until the next update for Riptide is ready, as I think it would be confusing to have the docs include features/information which aren't released/usable yet. It'd probably be good to set things up in a way that makes it possible to improve & tweak the live docs while excluding stuff related to unreleased feature changes & additions (perhaps with a separate branch for the docs of the latest release), but I could also see that getting a bit messy to maintain. Let me know if you've got any suggestions!

tom-weiland commented 6 months ago

I've just updated the docs site for v2.1.0 and external references are working properly. I'm still not sure what actually fixed it though 🤷‍♂️