Update links to the docs
This commit is contained in:
parent
19b5218278
commit
c38ab1d4e4
10 changed files with 15 additions and 15 deletions
|
@ -30,7 +30,7 @@ You can use Theatre.js to:
|
||||||
|
|
||||||
## Documentation and Tutorials
|
## Documentation and Tutorials
|
||||||
|
|
||||||
You can find the documentation and video tutorials [here](https://docs.theatrejs.com).
|
You can find the documentation and video tutorials [here](https://theatrejs.com/docs/latest).
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
|
|
|
@ -24,7 +24,7 @@ export {types}
|
||||||
* @remarks
|
* @remarks
|
||||||
* If \@theatre/studio is also loaded, then the state of the project will be managed by the studio.
|
* If \@theatre/studio is also loaded, then the state of the project will be managed by the studio.
|
||||||
*
|
*
|
||||||
* [Learn more about exporting](https://docs.theatrejs.com/in-depth/#exporting)
|
* [Learn more about exporting](https://www.theatrejs.com/docs/latest/manual/projects#state)
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* Usage:
|
* Usage:
|
||||||
|
@ -96,7 +96,7 @@ const shallowValidateOnDiskState = (projectId: ProjectId, s: OnDiskState) => {
|
||||||
throw new InvalidArgumentError(
|
throw new InvalidArgumentError(
|
||||||
`Error validating conf.state in Theatre.getProject(${JSON.stringify(
|
`Error validating conf.state in Theatre.getProject(${JSON.stringify(
|
||||||
projectId,
|
projectId,
|
||||||
)}, conf). The state seems to be formatted in a way that is unreadable to Theatre.js. Read more at https://docs.theatrejs.com`,
|
)}, conf). The state seems to be formatted in a way that is unreadable to Theatre.js. Read more at https://www.theatrejs.com/docs/latest/manual/projects#state`,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -17,7 +17,7 @@ import type {$IntentionalAny} from '@theatre/shared/utils/types'
|
||||||
*/
|
*/
|
||||||
export type IProjectConfig = {
|
export type IProjectConfig = {
|
||||||
/**
|
/**
|
||||||
* The state of the project, as [exported](https://docs.theatrejs.com/in-depth/#exporting) by the studio.
|
* The state of the project, as [exported](https://www.theatrejs.com/docs/latest/manual/projects#state) by the studio.
|
||||||
*/
|
*/
|
||||||
state?: $IntentionalAny
|
state?: $IntentionalAny
|
||||||
// experiments?: IProjectConfigExperiments
|
// experiments?: IProjectConfigExperiments
|
||||||
|
@ -67,7 +67,7 @@ export interface IProject {
|
||||||
* @param instanceId - Optionally provide an `instanceId` if you want to create multiple instances of the same Sheet
|
* @param instanceId - Optionally provide an `instanceId` if you want to create multiple instances of the same Sheet
|
||||||
* @returns The newly created Sheet
|
* @returns The newly created Sheet
|
||||||
*
|
*
|
||||||
* **Docs: https://docs.theatrejs.com/in-depth/#sheets**
|
* **Docs: https://www.theatrejs.com/docs/latest/manual/sheets**
|
||||||
*/
|
*/
|
||||||
sheet(sheetId: string, instanceId?: string): ISheet
|
sheet(sheetId: string, instanceId?: string): ISheet
|
||||||
}
|
}
|
||||||
|
|
|
@ -131,7 +131,7 @@ export interface ISequence {
|
||||||
*
|
*
|
||||||
* @returns A promise that resolves once the audio source is loaded and decoded
|
* @returns A promise that resolves once the audio source is loaded and decoded
|
||||||
*
|
*
|
||||||
* Learn more [here](https://docs.theatrejs.com/in-depth/#sequence-attachaudio).
|
* Learn more [here](https://www.theatrejs.com/docs/latest/manual/audio).
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* Usage:
|
* Usage:
|
||||||
|
|
|
@ -42,7 +42,7 @@ export interface ISheet {
|
||||||
/**
|
/**
|
||||||
* Creates a child object for the sheet
|
* Creates a child object for the sheet
|
||||||
*
|
*
|
||||||
* **Docs: https://docs.theatrejs.com/in-depth/#objects**
|
* **Docs: https://www.theatrejs.com/docs/latest/manual/objects**
|
||||||
*
|
*
|
||||||
* @param key - Each object is identified by a key, which is a non-empty string
|
* @param key - Each object is identified by a key, which is a non-empty string
|
||||||
* @param props - The props of the object. See examples
|
* @param props - The props of the object. See examples
|
||||||
|
|
|
@ -30,7 +30,7 @@ You can use Theatre.js to:
|
||||||
|
|
||||||
## Documentation and Tutorials
|
## Documentation and Tutorials
|
||||||
|
|
||||||
You can find the documentation and video tutorials [here](https://docs.theatrejs.com).
|
You can find the documentation and video tutorials [here](https://www.theatrejs.com/docs/latest).
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
|
|
|
@ -43,7 +43,7 @@ const EmptyState: FC = () => {
|
||||||
{/* Links like this should probably be managed centrally so that we can
|
{/* Links like this should probably be managed centrally so that we can
|
||||||
have a process for updating them when the docs change. */}
|
have a process for updating them when the docs change. */}
|
||||||
<LinkToDoc
|
<LinkToDoc
|
||||||
href="https://docs.theatrejs.com/in-depth/#objects"
|
href="https://www.theatrejs.com/docs/latest/manual/objects"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
>
|
>
|
||||||
Learn more about Objects
|
Learn more about Objects
|
||||||
|
|
|
@ -70,7 +70,7 @@ const ProjectDetails: React.FC<{
|
||||||
commit this file to your git repo and include it in your production
|
commit this file to your git repo and include it in your production
|
||||||
bundle.
|
bundle.
|
||||||
<a
|
<a
|
||||||
href="https://docs.theatrejs.com/in-depth/#exporting"
|
href="https://www.theatrejs.com/docs/latest/manual/projects#state"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
>
|
>
|
||||||
Here is a quick guide on how to export to production.
|
Here is a quick guide on how to export to production.
|
||||||
|
|
|
@ -107,7 +107,7 @@ const InConflict: React.FC<{
|
||||||
<Message>
|
<Message>
|
||||||
Browser state is not based on disk state.{' '}
|
Browser state is not based on disk state.{' '}
|
||||||
<a
|
<a
|
||||||
href="https://docs.theatrejs.com/in-depth/#exporting"
|
href="https://www.theatrejs.com/docs/latest/manual/projects#state"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
>
|
>
|
||||||
Learn more.
|
Learn more.
|
||||||
|
|
|
@ -124,7 +124,7 @@ const MoreMenu = React.forwardRef((props: {}, ref) => {
|
||||||
<Container ref={ref as $IntentionalAny}>
|
<Container ref={ref as $IntentionalAny}>
|
||||||
<Link
|
<Link
|
||||||
as="a"
|
as="a"
|
||||||
href="https://docs.theatrejs.com"
|
href="https://www.theatrejs.com/docs/latest"
|
||||||
className=""
|
className=""
|
||||||
target="_blank"
|
target="_blank"
|
||||||
>
|
>
|
||||||
|
@ -133,7 +133,7 @@ const MoreMenu = React.forwardRef((props: {}, ref) => {
|
||||||
|
|
||||||
<Link
|
<Link
|
||||||
as="a"
|
as="a"
|
||||||
href={`https://docs.theatrejs.com/changelog`}
|
href={`https://www.theatrejs.com/docs/latest/releases`}
|
||||||
className=""
|
className=""
|
||||||
target="_blank"
|
target="_blank"
|
||||||
>
|
>
|
||||||
|
@ -184,7 +184,7 @@ const MoreMenu = React.forwardRef((props: {}, ref) => {
|
||||||
<Divider />
|
<Divider />
|
||||||
<Link
|
<Link
|
||||||
as="a"
|
as="a"
|
||||||
href={`https://docs.theatrejs.com/update#${encodeURIComponent(
|
href={`https://www.theatrejs.com/docs/latest/releases${encodeURIComponent(
|
||||||
untaggedVersion,
|
untaggedVersion,
|
||||||
)}`}
|
)}`}
|
||||||
className=""
|
className=""
|
||||||
|
@ -195,7 +195,7 @@ const MoreMenu = React.forwardRef((props: {}, ref) => {
|
||||||
</Link>
|
</Link>
|
||||||
<Link
|
<Link
|
||||||
as="a"
|
as="a"
|
||||||
href={`https://docs.theatrejs.com/changelog#${encodeURIComponent(
|
href={`https://www.theatrejs.com/docs/latest/releases#${encodeURIComponent(
|
||||||
untaggedVersion,
|
untaggedVersion,
|
||||||
)}`}
|
)}`}
|
||||||
className=""
|
className=""
|
||||||
|
|
Loading…
Reference in a new issue