variablelab/theatre
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update links to the docs

Browse source
This commit is contained in:
Aria Minaei 2022-11-24 17:42:13 +01:00
parent 19b5218278
commit c38ab1d4e4
10 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
theatre/core/README.md
View file

@ -30,7 +30,7 @@ You can use Theatre.js to:
## 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

4
theatre/core/src/coreExports.ts
View file

@ -24,7 +24,7 @@ export {types}
* @remarks
* 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
* Usage:
@ -96,7 +96,7 @@ const shallowValidateOnDiskState = (projectId: ProjectId, s: OnDiskState) => {
throw new InvalidArgumentError(
`Error validating conf.state in Theatre.getProject(${JSON.stringify(
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`,
)
}
}

4
theatre/core/src/projects/TheatreProject.ts
View file

@ -17,7 +17,7 @@ import type {$IntentionalAny} from '@theatre/shared/utils/types'
*/
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
// 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
* @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
}

2
theatre/core/src/sequences/TheatreSequence.ts
View file

@ -131,7 +131,7 @@ export interface ISequence {
*
* @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
* Usage:

2
theatre/core/src/sheets/TheatreSheet.ts
View file

@ -42,7 +42,7 @@ export interface ISheet {
/**
* 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 props - The props of the object. See examples

2
theatre/studio/README.md
View file

@ -30,7 +30,7 @@ You can use Theatre.js to:
## 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

2
theatre/studio/src/panels/DetailPanel/EmptyState.tsx
View file

@ -43,7 +43,7 @@ const EmptyState: FC = () => {
{/* Links like this should probably be managed centrally so that we can
have a process for updating them when the docs change. */}
<LinkToDoc
href="https://docs.theatrejs.com/in-depth/#objects"
href="https://www.theatrejs.com/docs/latest/manual/objects"
target="_blank"
>
Learn more about Objects

2
theatre/studio/src/panels/DetailPanel/ProjectDetails.tsx
View file

@ -70,7 +70,7 @@ const ProjectDetails: React.FC<{
commit this file to your git repo and include it in your production
bundle.
<a
href="https://docs.theatrejs.com/in-depth/#exporting"
href="https://www.theatrejs.com/docs/latest/manual/projects#state"
target="_blank"
>
Here is a quick guide on how to export to production.

2
theatre/studio/src/panels/DetailPanel/ProjectDetails/StateConflictRow.tsx
View file

@ -107,7 +107,7 @@ const InConflict: React.FC<{
<Message>
Browser state is not based on disk state.{' '}
<a
href="https://docs.theatrejs.com/in-depth/#exporting"
href="https://www.theatrejs.com/docs/latest/manual/projects#state"
target="_blank"
>
Learn more.

8
theatre/studio/src/toolbars/MoreMenu/MoreMenu.tsx
View file

@ -124,7 +124,7 @@ const MoreMenu = React.forwardRef((props: {}, ref) => {
<Container ref={ref as $IntentionalAny}>
<Link
as="a"
href="https://docs.theatrejs.com"
href="https://www.theatrejs.com/docs/latest"
className=""
target="_blank"
>
@ -133,7 +133,7 @@ const MoreMenu = React.forwardRef((props: {}, ref) => {
<Link
as="a"
href={`https://docs.theatrejs.com/changelog`}
href={`https://www.theatrejs.com/docs/latest/releases`}
className=""
target="_blank"
>
@ -184,7 +184,7 @@ const MoreMenu = React.forwardRef((props: {}, ref) => {
<Divider />
<Link
as="a"
href={`https://docs.theatrejs.com/update#${encodeURIComponent(
href={`https://www.theatrejs.com/docs/latest/releases${encodeURIComponent(
untaggedVersion,
)}`}
className=""
@ -195,7 +195,7 @@ const MoreMenu = React.forwardRef((props: {}, ref) => {
</Link>
<Link
as="a"
href={`https://docs.theatrejs.com/changelog#${encodeURIComponent(
href={`https://www.theatrejs.com/docs/latest/releases#${encodeURIComponent(
untaggedVersion,
)}`}
className=""