Skip to content

docs: Update repo and both package readme files#1180

Merged
JesseOlmer merged 6 commits intodevelopfrom
docs/readme
Sep 17, 2021
Merged

docs: Update repo and both package readme files#1180
JesseOlmer merged 6 commits intodevelopfrom
docs/readme

Conversation

@JesseOlmer
Copy link
Copy Markdown
Contributor

  • Removes readme duplication
  • Repo & Contribution guidelines exist exclusively in root repo readme
  • Package readme's are thinned down to something which makes sense in an offline context as well (in the shipped package tarballs)
  • Change MLAPI references to Netcode for GameObjects
  • Remove MLAPI logo

- Removes readme duplication
- Repo & Contribution guidelines exist exclusively in root repo readme
- Package readme's are thinned down to something which makes sense in an offline context as well (in the shipped package tarballs)
- Change MLAPI references to Netcode for GameObjects
- Remove MLAPI logo
@Briancoughlin
Copy link
Copy Markdown
Contributor

@JesseOlmer I have a question about the Transport Docs links. They are linking to our site but to the packages site, should it not link to us? The other links all go to our site , it seems odd to push multiplayer users of transport to a different site, and may lead to a more broken end to end user experience.

@JesseOlmer
Copy link
Copy Markdown
Contributor Author

@JesseOlmer I have a question about the Transport Docs links. They are linking to our site but to the packages site, should it not link to us? The other links all go to our site , it seems odd to push multiplayer users of transport to a different site, and may lead to a more broken end to end user experience.

Right now our site doesn't have 1.0 docs, but the Unity docs site does. The Unity docs site is also the first search result for the package on every search engine I checked - if we want to not "break" end-user experience we should change those docs to point at the other site.

@Briancoughlin
Copy link
Copy Markdown
Contributor

@JesseOlmer I have a question about the Transport Docs links. They are linking to our site but to the packages site, should it not link to us? The other links all go to our site , it seems odd to push multiplayer users of transport to a different site, and may lead to a more broken end to end user experience.

Right now our site doesn't have 1.0 docs, but the Unity docs site does. The Unity docs site is also the first search result for the package on every search engine I checked - if we want to not "break" end-user experience we should change those docs to point at the other site.

I have not written the 1.0 docs for transport so im not sure what those docs are?

@Briancoughlin
Copy link
Copy Markdown
Contributor

@JesseOlmer I have a question about the Transport Docs links. They are linking to our site but to the packages site, should it not link to us? The other links all go to our site , it seems odd to push multiplayer users of transport to a different site, and may lead to a more broken end to end user experience.

Right now our site doesn't have 1.0 docs, but the Unity docs site does. The Unity docs site is also the first search result for the package on every search engine I checked - if we want to not "break" end-user experience we should change those docs to point at the other site.

I have not written the 1.0 docs for transport so im not sure what those docs are?

Problem solved ( these are auto generated by the package ) I'm doing an Index.md for transport similar to ours in Netcode that will stop the two sources of trust issue. I will talk to someone around the SEO for google search

@TwoTenPvP
Copy link
Copy Markdown
Contributor

TwoTenPvP commented Sep 15, 2021

For future-proofing, we should change the shield URLs to point to Unity-Technologies/com.unity.netcode.gameobjects.

Perhaps also delete the download shield since that's not a relevant number as we go through the package registry now.

@JesseOlmer
Copy link
Copy Markdown
Contributor Author

For future-proofing, we should change the shield URLs to point to Unity-Technologies/com.unity.netcode.gameobjects.

Perhaps also delete the download shield since that's not a relevant number as we go through the package registry now.

Good call on the shield URLs - fixed.
I removed the download count badge, but left in the release badge, as even though we'll be releasing through package registry I'd like us to continue to create github releases as well.

@JesseOlmer JesseOlmer enabled auto-merge (squash) September 17, 2021 15:23
@JesseOlmer JesseOlmer merged commit d2db394 into develop Sep 17, 2021
@JesseOlmer JesseOlmer deleted the docs/readme branch September 17, 2021 16:28
SamuelBellomo added a commit that referenced this pull request Sep 17, 2021
* develop:
  feat: INetworkMessage (#1187)
  fix: Increase timeout for UTP adapter tests (#1199)
  docs: Update repo and both package readme files (#1180)
  chore: updating UTP package to pull in DTLS fixes (#1197)
  fix: network time arguments (#1194)
  feat: network physics (#1175)

# Conflicts:
#	com.unity.netcode.gameobjects/Components/Interpolator/BufferedLinearInterpolator.cs
#	com.unity.netcode.gameobjects/Components/NetworkTransform.cs
#	testproject/Assets/Prefabs/PlayerCube.prefab
SamuelBellomo added a commit that referenced this pull request Sep 17, 2021
…transform-teleport

* sam/feature/client-network-transform:
  adding proper delta sending
  feat: INetworkMessage (#1187)
  fix: Increase timeout for UTP adapter tests (#1199)
  docs: Update repo and both package readme files (#1180)
  chore: updating UTP package to pull in DTLS fixes (#1197)
  fix: network time arguments (#1194)
  feat: network physics (#1175)

# Conflicts:
#	testproject/Assets/Scenes/ZooSam.unity
mollstam pushed a commit to Keepsake-Games/com.unity.netcode.gameobjects that referenced this pull request Feb 13, 2023
)

- Removes readme duplication
- Repo & Contribution guidelines exist exclusively in root repo readme
- Package readme's are thinned down to something which makes sense in an offline context as well (in the shipped package tarballs)
- Change MLAPI references to Netcode for GameObjects
- Remove MLAPI logo
- Remove downloads badge
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