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

Remove @tldraw/utils from the docs site #1596

Merged
merged 3 commits into from
Jun 15, 2023
Merged

Conversation

TodePond
Copy link
Collaborator

@TodePond TodePond commented Jun 15, 2023

This PR removes the @tldraw/utils package from the docs site's API reference. It does this by removing it from the docs site's devDependencies.

The reason for this is this:

Screenshot 2023-06-15 at 15 52 24

Change Type

  • documentation — Changes to the documentation only1

Test Plan

  1. Check the API Reference page of the docs.
  2. Make that @tldraw/utils isn't there.

Release Notes

  • [docs] Removed an internal utilities package.

Footnotes

  1. will not publish a new version

@vercel
Copy link

vercel bot commented Jun 15, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
examples ✅ Ready (Inspect) Visit Preview Jun 15, 2023 2:54pm
tldraw-docs-staging ✅ Ready (Inspect) Visit Preview Jun 15, 2023 2:54pm

Comment on lines +59 to +63
"//": [
"Anything that starts with @tldraw in devDependencies will get included in the docs site.",
"We have to list them here so lazyrepo knows the docs depends on those packages (ie their",
"tsdoc comments), even though we don't use any of their code to run the docs site."
],
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Wording by @SomeHats

@TodePond TodePond marked this pull request as ready for review June 15, 2023 14:23
@huppy-bot huppy-bot bot added the docs Changes only affect the documentation label Jun 15, 2023
@TodePond TodePond requested a review from SomeHats June 15, 2023 14:23
@TodePond TodePond marked this pull request as draft June 15, 2023 14:30
@TodePond TodePond changed the title Lu/remove utils from docs Remove @tldraw/utils from the docs site Jun 15, 2023
@TodePond TodePond marked this pull request as ready for review June 15, 2023 14:52
@steveruizok steveruizok added this pull request to the merge queue Jun 15, 2023
Merged via the queue into main with commit 6d4d942 Jun 15, 2023
@steveruizok steveruizok deleted the lu/remove-utils-from-docs branch June 15, 2023 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Changes only affect the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants