From e889ad7405020dfb734a296ebe22012e1279895c Mon Sep 17 00:00:00 2001 From: Michael Adaixo Date: Thu, 13 Jun 2024 11:31:47 +0100 Subject: [PATCH] minor --- src/components/ClassRef.astro | 3 ++- src/content/docs/reference/FlowActorReference.md | 3 ++- src/content/docs/reference/FlowTypes.md | 1 - src/content/docs/reference/UFlowPilot.mdx | 5 ----- .../reference/{uflowpilotparent.md => UFlowPilotParent.mdx} | 4 ++++ .../docs/reference/{uflowpilottask.md => UFlowPilotTask.mdx} | 4 ++++ 6 files changed, 12 insertions(+), 8 deletions(-) rename src/content/docs/reference/{uflowpilotparent.md => UFlowPilotParent.mdx} (80%) rename src/content/docs/reference/{uflowpilottask.md => UFlowPilotTask.mdx} (81%) diff --git a/src/components/ClassRef.astro b/src/components/ClassRef.astro index e816446..4e7d7dd 100644 --- a/src/components/ClassRef.astro +++ b/src/components/ClassRef.astro @@ -8,6 +8,7 @@ const { className, parent } = Astro.props ---
- {className} : {parent} + {className} : + {parent}
diff --git a/src/content/docs/reference/FlowActorReference.md b/src/content/docs/reference/FlowActorReference.md index 7529ed0..717515d 100644 --- a/src/content/docs/reference/FlowActorReference.md +++ b/src/content/docs/reference/FlowActorReference.md @@ -7,6 +7,7 @@ description: Class used to grab a reference to an actor in FlowPilot Flow Actor Reference is a class that helps find a reference to an actor that can be in game, in the level, or not spawned yet. It uses 3 modes of operation. + - You can reference 'Self', which will return the current object running FlowPilot (that owns FlowPilotComponent) - You can reference an Actor in a Level. -- You can reference an Actor via GameplayTag. These are most useful when an Actor is not persistent in the level. These will also allow returning groups of Actors \ No newline at end of file +- You can reference an Actor via GameplayTag. These are most useful when an Actor is not persistent in the level. These will also allow returning groups of Actors diff --git a/src/content/docs/reference/FlowTypes.md b/src/content/docs/reference/FlowTypes.md index 81b44be..6124df4 100644 --- a/src/content/docs/reference/FlowTypes.md +++ b/src/content/docs/reference/FlowTypes.md @@ -4,4 +4,3 @@ description: FlowTypes.h contains definition about various types used throughout --- ## Description - diff --git a/src/content/docs/reference/UFlowPilot.mdx b/src/content/docs/reference/UFlowPilot.mdx index 247af3c..cdca10e 100644 --- a/src/content/docs/reference/UFlowPilot.mdx +++ b/src/content/docs/reference/UFlowPilot.mdx @@ -9,9 +9,4 @@ import ClassRef from '../../../components/ClassRef.astro' ## Description -Reference pages are ideal for outlining how things work in terse and clear terms. -Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting. -## Further reading - -- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework diff --git a/src/content/docs/reference/uflowpilotparent.md b/src/content/docs/reference/UFlowPilotParent.mdx similarity index 80% rename from src/content/docs/reference/uflowpilotparent.md rename to src/content/docs/reference/UFlowPilotParent.mdx index 2a43ff9..025ed5e 100644 --- a/src/content/docs/reference/uflowpilotparent.md +++ b/src/content/docs/reference/UFlowPilotParent.mdx @@ -3,6 +3,10 @@ title: UFlowPilotParent description: A reference page in my new Starlight docs site. --- +import ClassRef from '../../../components/ClassRef.astro' + + + ## Description Reference pages are ideal for outlining how things work in terse and clear terms. diff --git a/src/content/docs/reference/uflowpilottask.md b/src/content/docs/reference/UFlowPilotTask.mdx similarity index 81% rename from src/content/docs/reference/uflowpilottask.md rename to src/content/docs/reference/UFlowPilotTask.mdx index 6c31be3..ac8fdf9 100644 --- a/src/content/docs/reference/uflowpilottask.md +++ b/src/content/docs/reference/UFlowPilotTask.mdx @@ -3,6 +3,10 @@ title: UFlowPilotTask description: A reference page in my new Starlight docs site. --- +import ClassRef from '../../../components/ClassRef.astro' + + + ## Description Reference pages are ideal for outlining how things work in terse and clear terms.