Skip to content

Copy docs to package #6232

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

Open
wants to merge 103 commits into
base: develop
Choose a base branch
from
Open

Copy docs to package #6232

wants to merge 103 commits into from

Conversation

maryamziaa
Copy link
Contributor

@maryamziaa maryamziaa commented Aug 1, 2025

Proposed change(s)

Copy the documentation from the webpage into the package and modify it to be compatible with the package format. We're planning to use Unity Package documentation as the primary developer documentation and deprecate the maintenance of web docs.

Types of change(s)

  • Bug fix
  • New feature
  • Code refactor
  • Breaking change
  • Documentation update
  • Other (please describe)

Checklist

  • Added tests that prove my fix is effective or that my feature works
  • Updated the changelog (if applicable)
  • Updated the documentation (if applicable)
  • Updated the migration guide (if applicable)

Other comments

Copy link
Member

@gilescoope gilescoope left a comment

Choose a reason for hiding this comment

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

Looks good, just a question about the text formatting, also can't we remove the doxygen stuff?

@@ -0,0 +1,20 @@
# API Reference

Our developer-facing C# classes have been documented to be compatible with
Copy link
Member

Choose a reason for hiding this comment

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

Should our docs be written with line breaks like this? The other package docs seem to not have line breaks for formatting.

Choose a reason for hiding this comment

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

It's true that the other package docs don't use line breaks like that. I was going to say something, but when I looked at the local built, it looks like it renders OK. I don't want to ask y'all to fix all of the line breaks if it's not actually necessary.

Copy link
Member

Choose a reason for hiding this comment

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

ah ok, thanks @maryamziaa if there is a fairly automated way of fixing this to remove the line breaks in paragraphs then please do it, otherwise if it's too much work you can leave it as is.

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.

4 participants