Skip to content

Commit

Permalink
adds about category.
Browse files Browse the repository at this point in the history
  • Loading branch information
Mikea15 committed Jun 9, 2024
1 parent 9bface2 commit 14f1742
Show file tree
Hide file tree
Showing 11 changed files with 152 additions and 9 deletions.
21 changes: 18 additions & 3 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,38 @@ import starlight from '@astrojs/starlight';
export default defineConfig({
integrations: [
starlight({
title: 'FlowPilot Documentation',
title: 'FlowPilot',
description: 'Unreal Engine Code Plugin: Simple, modular and extensible gameplay system that allows fast data-driven gameplay flow creation.',
social: {
github: 'https://github.com/mikea15/ueflowpilot',
discord: 'https://discord.gg/sF9KjZ9qqj',
twitter: 'https://twitter.com/michaeladaixo',
'x.com': 'https://twitter.com/michaeladaixo',
},
components: {
Footer: './src/components/CustomFooter.astro',
},
editLink: {
baseUrl: 'https://github.com/Mikea15/UEFlowPilot/tree/main/',
},
sidebar: [
{
label: 'Guides',
label: 'About',
items: [
// Each item here is one entry in the navigation menu.
{ label: 'Example Guide', link: '/guides/example/' },
{ label: 'Changelog', link: '/about/changelog/' },
],
},
{
label: 'Guides',
autogenerate: { directory: 'guides' },
},
{
label: 'Reference',
autogenerate: { directory: 'reference' },
},
],
credits: true,
}),
],
});
20 changes: 20 additions & 0 deletions src/components/CustomFooter.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
import type { Props } from '@astrojs/starlight/props';
import Default from '@astrojs/starlight/components/Footer.astro';
const isHomepage = Astro.props.slug === '';
---

{
isHomepage ? (
<footer>Built with Starlight 🌟</footer>
) : (
<Default {...Astro.props}>
<slot />
</Default>
)
}

<!-- 100% privacy-first analytics -->
<script async defer src="https://scripts.simpleanalyticscdn.com/latest.js"></script>
<noscript><img src="https://queue.simpleanalyticscdn.com/noscript.gif" alt="" referrerpolicy="no-referrer-when-downgrade" /></noscript>
66 changes: 66 additions & 0 deletions src/content/docs/about/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: Changelog
description: Record of all FLowPilot changes per version update.
---

### 0.8

- Improve Error Logging
- Adds Example content to plugin
- Adds Customization and improves Debug View.
- Adds FlowPilotEditor
- Adds Base functionality to FlowPilotEditor
- Renames UFPTaskNode to UFlowPilotTask

### 0.6 - 17/02/2024

- Add support for 5.2
- Set plugin to runtime so we can use FlowPilotComponent in Blueprints
- Adds FlowPilotEditor
- Minor bug fixes

### 0.5 - 08/02/2024

- Removes Component from Cache
- Fix Data asset sharing with instancing of assets
- Sanitization pass across API calls
- Adds Stats Trackers at various points

### 0.4.1 - 24/01/2024

- Updates validation pattern
- Adds support for Unreal Engine 5.1

### 0.4 - 23/01/2024

- Added ways to Pause and Unpause FlowPilot
- Added parameters to settings to configure Debug Rendering
- Added proper Reset and Aborts to any Node that has Child Nodes, so they are properly propagated
- Fix Parallel node wrong execution end
- Fix debug rendering. Removed some options that we don't need for now and can be added later.
- Simplified flow. Removed Instant nodes, they were not being used.
- Added internal node state to better progress tracking
- Added a way to find multiple actors from 1 external tag, so we can use group references
- Added option to prefetch actors on Setup in Settings.
- Inverted ChangeLog timestamps

### 0.3.2 - 31/12/2023

- Implement Actor Reference Tag Prefetch.
- Prevent swapping FlowPilot Actor asset when Flow is already running
- Allows returning Groups of Actors from an FlowActorReference via Tags. Allows Group Search, Caching and Selection

### 0.3.1 - 30/12/2023

- Add Retry timer to FlowPilotComponent
- Properly add State change to FlowPilotComponent
- Properly invalidate Database Cache in FlowPilotSubsystem when an Actor is not valid when fetching it

### 0.3 - 29/12/2023

- Fix Parallel Node not completing correctly.
- Fix FlowComponent not registering correct FlowState

### 0.1 alpha - 12/12/2023

- First alpha release.
11 changes: 11 additions & 0 deletions src/content/docs/guides/example copy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Example Guide 2
description: A guide in my new Starlight docs site.
---

Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
Writing a good guide requires thinking about what your users are trying to do.

## Further reading

- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
12 changes: 6 additions & 6 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: Welcome to Starlight
description: Get started building your docs site with Starlight.
title: Welcome to FlowPilot!
description: Get up running with FlowPilot in no time!
template: splash
hero:
tagline: Congrats on setting up a new Starlight project!
tagline: Get up running with FlowPilot in no time!
image:
file: ../../assets/houston.webp
actions:
- text: Example Guide
- text: Start with a 'Getting Started' Guide
link: /guides/example/
icon: right-arrow
variant: primary
- text: Read the Starlight docs
link: https://starlight.astro.build
- text: Open the Reference Doc
link: /guides/reference/
icon: external
---

Expand Down
12 changes: 12 additions & 0 deletions src/content/docs/reference/FlowActorReference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: FlowActorReference
description: Class used to grab a reference to an actor in FlowPilot
---

## Description

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
6 changes: 6 additions & 0 deletions src/content/docs/reference/FlowPilotSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: FlowPilotSettings
description: Settings to help debug and customize FlowPilot
---

## Description
7 changes: 7 additions & 0 deletions src/content/docs/reference/FlowTypes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: FlowTypes
description: FlowTypes.h contains definition about various types used throughout FlowPilot
---

## Description

2 changes: 2 additions & 0 deletions src/content/docs/reference/uflowpilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: UFlowPilot
description: A reference page in my new Starlight docs site.
---

## 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.

Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/reference/uflowpilotparent.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: UFlowPilotParent
description: A reference page in my new Starlight docs site.
---

## 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.

Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/reference/uflowpilottask.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: UFlowPilotTask
description: A reference page in my new Starlight docs site.
---

## 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.

Expand Down

0 comments on commit 14f1742

Please sign in to comment.