Skip to content

docs: Adding docs to the 2.4 version of the package #3521

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

Merged
merged 4 commits into from
Jul 4, 2025

Conversation

jabbacakes
Copy link
Contributor

@jabbacakes jabbacakes commented Jun 25, 2025

Adding documentation to the 2.4 version of the package ahead of deprecating the Docusaurus-based site.

Changelog

  • Added: Package documentation.

Testing and Documentation

  • Includes edits to existing public manual documentation.
  • Tested and building locally.

Backport

No plan to backport to older 2.x versions, too much faff involved in the conversion from Docusaurus format to standard package Markdown format. (corresponding PR is #3520)

@jabbacakes jabbacakes requested a review from a team as a code owner June 25, 2025 15:46
@unity-cla-assistant
Copy link

unity-cla-assistant commented Jun 25, 2025

CLA assistant check
All committers have signed the CLA.

@jabbacakes jabbacakes changed the title Adding docs to the 2.4 version of the package docs: Adding docs to the 2.4 version of the package Jun 25, 2025
@jabbacakes jabbacakes enabled auto-merge (squash) July 3, 2025 10:02
@jabbacakes
Copy link
Contributor Author

Hey @michalChrobot, what can we do to get this merged? All of the failing tests are (as far as I can tell) unrelated to the changes in this PR. Same goes for #3520

@michalChrobot
Copy link
Collaborator

Hey, let me just quickly rerun those failures to see if this is nothing I should worry about (but even if then it can't be related to your changes). Both @EmandM and @NoelStephensUnity are on holidays until later next week but I think we can merge it since it shouldn't be anything that could be objected

@michalChrobot michalChrobot disabled auto-merge July 4, 2025 07:58
michalChrobot pushed a commit that referenced this pull request Jul 4, 2025
Adding documentation to the 1.13 version of the package ahead of
deprecating the Docusaurus-based site.

## Changelog

- Added: Package documentation.

## Testing and Documentation

- Includes edits to existing public manual documentation.
- Tested and building locally.

## Backport

No plan to backport to older 1.x versions, too much faff involved in the
conversion from Docusaurus format to standard package Markdown format.
(Corresponding PR is
#3521)
@michalChrobot michalChrobot merged commit a06c9d8 into develop-2.0.0 Jul 4, 2025
31 of 36 checks passed
@michalChrobot michalChrobot deleted the develop-2.0.0-docs branch July 4, 2025 08:01
@jabbacakes
Copy link
Contributor Author

Thanks @michalChrobot <3

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