-
Notifications
You must be signed in to change notification settings - Fork 522
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding TOC and index to readme [MTT-4617] #736
Conversation
Initial draft, links are not made yet. Let me know what you think of this format before I invest more time in this |
8845bf6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lots of nitpicks, but looking real good!
Co-authored-by: Fernando Cortez <fernando.cortez@unity3d.com>
…-Technologies/com.unity.multiplayer.samples.coop into sam/feat/better-indexing-in-readme * 'sam/feat/better-indexing-in-readme' of github.com:Unity-Technologies/com.unity.multiplayer.samples.coop: removing test and fixing a link test2 test, should be reverted
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it very much. An index to important classes is really cool.
bb12324
…-Technologies/com.unity.multiplayer.samples.coop into sam/feat/better-indexing-in-readme * 'sam/feat/better-indexing-in-readme' of github.com:Unity-Technologies/com.unity.multiplayer.samples.coop: Adding more player related entries
* develop: (60 commits) fix: removing FindObjectOfType for a serialized reference (#754) fix: can click through loading screen [MTT-4753] (#760) Update CHANGELOG.md (#765) feat: Architecture.md update (MTT-2637) (#763) Update README.md (#759) Updating utilities package for release (#764) Version bumps (#761) Updating broken PR links (shouldn't be linked to jira) and changelog fixes (#758) adding components refs to index (#757) Adding link to feedback form at the top (#756) chore: adding details to changelog (#746) Updating readme with Typeform for feedback (#755) made arrow trails smaller (#750) Fixed up some layer settings on some archer VFX so that they show up properly! (#739) fix: lobby UI unblocking before it should [MTT-4579] (#748) feat: PubSub improvement: ISubscriber unsub [MTT-2765] (#612) Fix: Reduction of SSAO Cost (Especially on Mac) [MTT-4558] (#753) fix: Moving utp to component instead of child GameObject (#752) Adding TOC and index to readme [MTT-4617] (#736) Feat: Char Portrait Mouse Hover Feedback [MTT-4754] (#751) ... # Conflicts: # Assets/Prefabs/NetworkingManager.prefab
Description
Learnings are not super easy to find. Readme is the landing page for folks. This PR aims to organize things a bit more by adding an encyclopaedia-style index of learnings that'd link to specific spots in the repo.
Adding TOC as well, in the same vein.
Issue Number(s)
MTT-4617
Contribution checklist