From 8a198c6d42571cffd6b1853be73fe676a8c2a9ba Mon Sep 17 00:00:00 2001 From: Patrick Hultquist Date: Mon, 3 Oct 2022 06:55:10 -0400 Subject: [PATCH] Remove references to docs script (#1003) * remove references to yarn docs * add back ref to source & ts --- guides/development.md | 2 -- guides/documentation.md | 17 +---------------- 2 files changed, 1 insertion(+), 18 deletions(-) diff --git a/guides/development.md b/guides/development.md index a8d32fc21..7421ee77b 100644 --- a/guides/development.md +++ b/guides/development.md @@ -13,5 +13,3 @@ From the root folder: Other scripts: - Run `yarn test` to execute unit tests via [Jest](https://jestjs.io). - -- Run `yarn docs` to build the docs via [ts-doc](https://typedoc.org/). diff --git a/guides/documentation.md b/guides/documentation.md index 51285f4b7..d054318a5 100644 --- a/guides/documentation.md +++ b/guides/documentation.md @@ -4,15 +4,6 @@ This file contains the documentation for the `` component as well as the data model that the component accepts. -In addition to the docs written below, this project also includes **generated documentation**. To view the generated docs: - -1. Run `yarn docs` from the root folder -2. Open the file at: - -``` -/packages/tldraw/docs/classes/TldrawApp.html -``` - ## `tldraw` The `Tldraw` React component is the [tldraw](https://tldraw.com) editor exported as a standalone component. You can control the editor through props, or through the `TldrawApp`'s imperative API. **All props are optional.** @@ -217,12 +208,6 @@ function App() { } ``` -To view the full documentation of the `TldrawApp` API, generate the project's documentation by running `yarn docs` from the root folder, then open the file at: - -``` -/packages/tldraw/docs/classes/TldrawApp.html -``` - Here are some useful methods: - `loadDocument` @@ -269,4 +254,4 @@ Here are some useful methods: - `selectTool` - `cancel` -Check the generated docs, source or the TypeScript types for more on these and other methods. +Check the source or the TypeScript types for more on these and other methods.