Skip to content
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

Merged
merged 34 commits into from
Sep 29, 2022

Conversation

SamuelBellomo
Copy link
Contributor

@SamuelBellomo SamuelBellomo commented Sep 23, 2022

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

  • n/a Tests have been added for boss room and/or utilities pack
  • Release notes have been added to the project changelog file and/or package changelog file
  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • JIRA ticket ID is in the PR title or at least one commit message
  • Include the ticket ID number within the body message of the PR to create a hyperlink

@SamuelBellomo SamuelBellomo added 0-URGENT Blocker for a release and needs to be merged ASAP and removed 0-URGENT Blocker for a release and needs to be merged ASAP labels Sep 23, 2022
@SamuelBellomo SamuelBellomo added the 0-URGENT Blocker for a release and needs to be merged ASAP label Sep 23, 2022
@SamuelBellomo
Copy link
Contributor Author

Initial draft, links are not made yet. Let me know what you think of this format before I invest more time in this

LPLafontaineB
LPLafontaineB previously approved these changes Sep 23, 2022
chrispope
chrispope previously approved these changes Sep 26, 2022
Copy link
Collaborator

@fernando-cortez fernando-cortez left a 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!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@fernando-cortez fernando-cortez added the 2-Reviewed with Comments PR requires owner's attention label Sep 28, 2022
Co-authored-by: Fernando Cortez <fernando.cortez@unity3d.com>
SamuelBellomo and others added 5 commits September 28, 2022 16:27
…-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
LPLafontaineB
LPLafontaineB previously approved these changes Sep 28, 2022
pdeschain
pdeschain previously approved these changes Sep 28, 2022
Copy link
Contributor

@pdeschain pdeschain left a 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.

SamuelBellomo and others added 4 commits September 29, 2022 11:14
…-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:
  Fix: Changed Default Quality Setting to Medium (#749)
  fix: adding RTT graph to RNSM [MTT-4788] (#747)

# Conflicts:
#	CHANGELOG.md
@fernando-cortez fernando-cortez added 2-One More Review One review in, one to go and removed 1-Needs Review PR needs attention from the assignee and reviewers labels Sep 29, 2022
@LPLafontaineB LPLafontaineB added 3-Good to Merge and removed 2-One More Review One review in, one to go labels Sep 29, 2022
@SamuelBellomo SamuelBellomo merged commit f3e9176 into develop Sep 29, 2022
@SamuelBellomo SamuelBellomo deleted the sam/feat/better-indexing-in-readme branch September 29, 2022 18:57
README.md Show resolved Hide resolved
SamuelBellomo added a commit that referenced this pull request Oct 13, 2022
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0-URGENT Blocker for a release and needs to be merged ASAP 3-Good to Merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants