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

CMCL-0000: Add user manual page for SimplePlayerController sample code #1004

Merged
merged 10 commits into from
Jun 11, 2024

Conversation

glabute
Copy link
Collaborator

@glabute glabute commented Jun 4, 2024

Purpose of this PR

The Cinemachine Samples have received some attention from the field. People like them, and they like the Simple Character Controller code that ships with them.

There is a feeling that CM's controller is easier to use and to customize than Unity's Standard Assets. We want to promote the usage of CM sample code, and for this reason it is interesting to add some user-facing documentation.

This PR is a first pass at that.

@glabute glabute requested a review from sebastienduverne as a code owner June 4, 2024 17:30
@codecov-commenter
Copy link

codecov-commenter commented Jun 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 27.16%. Comparing base (99eed58) to head (8f237ad).
Report is 6 commits behind head on main.

Current head 8f237ad differs from pull request most recent head cf7259a

Please upload reports for the commit cf7259a to get more accurate results.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1004   +/-   ##
=======================================
  Coverage   27.16%   27.16%           
=======================================
  Files         250      250           
  Lines       27958    27958           
=======================================
  Hits         7596     7596           
  Misses      20362    20362           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@sebastienduverne sebastienduverne left a comment

Choose a reason for hiding this comment

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

  • A few corrections and suggestions in manual, API docs, and tooltips.
  • Requirement: please add an entry to the new file in the TableOfContents.md – I'd say as the last child of the samples-tutorials.md page.

@glabute
Copy link
Collaborator Author

glabute commented Jun 11, 2024

All issues resolved

@glabute glabute merged commit 27420db into main Jun 11, 2024
5 of 9 checks passed
@glabute glabute deleted the dev/simple-controller-doc branch June 11, 2024 18:47
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