Add warning message to guides and fix some links

codytodonnell · May 17, 2024 · 70ce8dc · 70ce8dc
1 parent 6591245
commit 70ce8dc
Show file tree

Hide file tree

Showing 10 changed files with 63 additions and 43 deletions.
diff --git a/docs/docs/guides/combine-sections.md b/docs/docs/guides/combine-sections.md
@@ -2,6 +2,11 @@
 title: 'Combining Sections'
 ---
 
+:::warning
+
+This tutorial was written for v0.0.2 through v0.0.9 of strudel-kit. It is currently in the process of being updated for v0.1.0. 
+:::
+
 ## How to Combine Sections from Different Task Flows
 
 When using STRUDEL Kit it's common to want to take a section from one Task Flow and copy it into a different one. Doing so requires you to copy the desired components and elements from one Task Flow file into another file in the desired destination. The difficulty depends on the particular components, but in general, this is easy to do.

diff --git a/docs/docs/guides/connect-task-flows-together.md b/docs/docs/guides/connect-task-flows-together.md
@@ -2,6 +2,11 @@
 title: 'Connecting Task Flows'
 ---
 
+:::warning
+
+This tutorial was written for v0.0.2 through v0.0.9 of strudel-kit. It is currently in the process of being updated for v0.1.0. 
+:::
+
 ## How to Connect Task Flows Together
 
 Task Flows don't always exist in isolation inside apps. Instead, Task Flows often fit together in various ways. In this article you will learn how to connect steps from two different task flows into a larger flow.

diff --git a/docs/docs/guides/tutorials/basic-app-with-strudel/0-introduction.md b/docs/docs/guides/tutorials/basic-app-with-strudel/0-introduction.md
@@ -1,5 +1,10 @@
 # Getting Started with STRUDEL Kit (Beta)
 
+:::warning
+
+This tutorial was written for v0.0.2 through v0.0.9 of strudel-kit. It is currently in the process of being updated for v0.1.0. 
+:::
+
 In this tutorial you will learn the basics of how to build a web application using the STRUDEL Task Flow templates and STRUDEL CLI. By the end you will have your own customized version of the [Explore Data Task Flow](https://strudel.science/design-system/task-flows/explore-data/) running in a web browser on your computer.
 
 ### Who is this tutorial for?
@@ -12,30 +17,30 @@ If you encounter any issues along the way or have feedback about how we can impr
 
 ### Jump In
 
-1. [Set Up Your Development Environment](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/1-setup.md)
+1. [Set Up Your Development Environment](/strudel-kit/docs/guides/tutorials/basic-app-with-strudel/setup)
 
     Install all the prerequisite and core software that powers the STRUDEL Kit. 
 
-2. [Create a Base App with STRUDEL](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/2-create-app.md)
+2. [Create a Base App with STRUDEL](/strudel-kit/docs/guides/tutorials/basic-app-with-strudel/create-app)
 
     Get familiar with the STRUDEL CLI and generate the base scaffolding for a React app that uses the STRUDEL Design System.
 
-3. [Add a Task Flow to Your App](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/3-add-taskflow.md)
+3. [Add a Task Flow to Your App](/strudel-kit/docs/guides/tutorials/basic-app-with-strudel/add-taskflow)
 
     Learn how to add Task Flows into your app and build your own custom configurations.
 
-4. [Customize Your Task Flow](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/4-customize-taskflow.md)
+4. [Customize Your Task Flow](/strudel-kit/docs/guides/tutorials/basic-app-with-strudel/customize-taskflow)
 
     Familiarize yourself with the Task Flow code and learn how to make changes that are important to your use case.
 
-5. [Customize Your App](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/5-customize-app.md)
+5. [Customize Your App](/strudel-kit/docs/guides/tutorials/basic-app-with-strudel/customize-app)
 
     Make the app your own by changing the theme, adding styles, and adding custom sections.
 
-6. [Customize the Home Page](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/6-customize-home-page.md)
+6. [Customize the Home Page](/strudel-kit/docs/guides/tutorials/basic-app-with-strudel/customize-home-page)
 
     Build out a home page for your application.
 
-7. [Continue Learning](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/7-continue-learning.md)
+7. [Continue Learning](/strudel-kit/docs/guides/tutorials/basic-app-with-strudel/continue-learning)
 
     Discover resources to help you continue developing applications with STRUDEL.
diff --git a/docs/docs/guides/tutorials/basic-app-with-strudel/1-setup.md b/docs/docs/guides/tutorials/basic-app-with-strudel/1-setup.md
@@ -1,5 +1,10 @@
 # Set Up Your Development Environment
 
+:::warning
+
+This tutorial was written for v0.0.2 through v0.0.9 of strudel-kit. It is currently in the process of being updated for v0.1.0. 
+:::
+
 The current interface to using the STRUDEL Design System is a command-line tool written in Python. To use this tool, you need to set up a development environment that lets you invoke Python commands from a terminal.
 
 ### Open a Terminal Window
@@ -55,8 +60,4 @@ If you used conda and created an environment using the command in the guide, the
 
 ## Next Steps
 
-Now that you have the client installed, you can start building your first STRUDEL application.
-
-Previous           |  Next
-:-------------------------:|:-------------------------:
-[Introduction](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/1-introduction.md)  |  [Build an App with STRUDEL](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/2-create-app.md)
+Now that you have the client installed, you can start building your first STRUDEL application.
diff --git a/docs/docs/guides/tutorials/basic-app-with-strudel/2-create-app.md b/docs/docs/guides/tutorials/basic-app-with-strudel/2-create-app.md
@@ -4,6 +4,11 @@ slug: create-app
 
 # Create a Base App
 
+:::warning
+
+This tutorial was written for v0.0.2 through v0.0.9 of strudel-kit. It is currently in the process of being updated for v0.1.0. 
+:::
+
 We will now start to create your first STRUDEL app using the strudel-cli you installed in the previous step. The `strudel` command has several sub-commands to do different tasks; to create an app named *planets-app* use the `create-app` sub-command like this:
 
 ```
@@ -39,8 +44,4 @@ In the future, when you run your app, you will not need to perform the install s
 
 ## Next Steps
 
-Next you will learn how to add your first task flow to the app.
-
-Previous           |  Next
-:-------------------------:|:-------------------------:
-[Set Up Your Development Environment](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/1-setup.md)  |  [Add a Task Flow](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/3-add-taskflow.md)
+Next you will learn how to add your first task flow to the app.
diff --git a/docs/docs/guides/tutorials/basic-app-with-strudel/3-add-taskflow.md b/docs/docs/guides/tutorials/basic-app-with-strudel/3-add-taskflow.md
@@ -1,5 +1,10 @@
 # Add a Task Flow to Your App
 
+:::warning
+
+This tutorial was written for v0.0.2 through v0.0.9 of strudel-kit. It is currently in the process of being updated for v0.1.0. 
+:::
+
 ### Introduction
 
 Task Flows are are a set of steps (represented by a series of screens) that help to accomplish a task and represent how a user progresses through a UI. To start building your app, you first add a Task Flow. In this example, you will add the Task Flow called "Explore Data".
@@ -238,7 +243,3 @@ Woohoo! You have connected your first Task Flow.
 ## Next steps
 
 The next section provides some examples of how to customize your Task Flow.
-
-Previous           |  Next
-:-------------------------:|:-------------------------:
-[Build an App with STRUDEL](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/2-create-app.md)  |  [Customize Task Flow](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/4-customize-taskflow.md)
diff --git a/docs/docs/guides/tutorials/basic-app-with-strudel/4-customize-taskflow.md b/docs/docs/guides/tutorials/basic-app-with-strudel/4-customize-taskflow.md
@@ -1,5 +1,10 @@
 # Customize Your Task Flow
 
+:::warning
+
+This tutorial was written for v0.0.2 through v0.0.9 of strudel-kit. It is currently in the process of being updated for v0.1.0. 
+:::
+
 Now that you have set up your initial task flow let's customize some of the content within it. In this section you will learn how to remove, add, and edit sections in a task flow page.
 
 ## Remove an Element
@@ -223,8 +228,4 @@ Woohoo! You're done with task flow customizations for now.
 
 ## Next Steps
 
-At this point you have a task flow that is starting to be tailored to a particular data source and use-case. In the next section you will learn how to customize the app as a whole and make it your own.
-
-Previous           |  Next
-:-------------------------:|:-------------------------:
-[Add a Task Flow](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/3-add-taskflow.md)  |  [Customize Your App](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/5-customize-app.md)
+At this point you have a task flow that is starting to be tailored to a particular data source and use-case. In the next section you will learn how to customize the app as a whole and make it your own.
diff --git a/docs/docs/guides/tutorials/basic-app-with-strudel/5-customize-app.md b/docs/docs/guides/tutorials/basic-app-with-strudel/5-customize-app.md
@@ -1,5 +1,10 @@
 # Customize Your App
 
+:::warning
+
+This tutorial was written for v0.0.2 through v0.0.9 of strudel-kit. It is currently in the process of being updated for v0.1.0. 
+:::
+
 For most web applications, it is important to include content and alterations that are unique to your project. In this section you will learn the basics of how to make the app your own by changing the theme, styles, and general content.
 
 ## Modify the Global Theme
@@ -227,8 +232,4 @@ Hooray! You are all done customizing app styles for this tutorial.
 
 ## Next Steps
 
-In the last section of this tutorial, you will put what you have learned together to edit the app's home page.
-
-Previous           |  Next
-:-------------------------:|:-------------------------:
-[Customize Your Task Flow](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/4-customize-taskflow.md)  |  [Customize the Home Page](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/6-customize-home-page.md)
+In the last section of this tutorial, you will put what you have learned together to edit the app's home page.
diff --git a/docs/docs/guides/tutorials/basic-app-with-strudel/6-customize-home-page.md b/docs/docs/guides/tutorials/basic-app-with-strudel/6-customize-home-page.md
@@ -1,5 +1,10 @@
 # Customize the Home Page
 
+:::warning
+
+This tutorial was written for v0.0.2 through v0.0.9 of strudel-kit. It is currently in the process of being updated for v0.1.0. 
+:::
+
 STRUDEL generates a default home page in `src/app/home/HomePage.tsx`. In this section you will add some content, images, and links to the home page.
 
 First, let's add a title. To add a title, use the `Typography` component from MUI. This is a general component for different variations of text. You can read more about the `Typography` component on the[ MUI `Typography` documentation page](https://mui.com/material-ui/react-typography/).
@@ -81,8 +86,4 @@ That's looking pretty good!
 
 ## Next Steps
 
-In the last section you will find resources to continue building your app and learning the STRUDEL Tech Stack.
-
-Previous           |  Next
-:-------------------------:|:-------------------------:
-[Customize Your App](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/5-customize-app.md)  |  [Continue Learning](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/7-continue-learning.md)
+In the last section you will find resources to continue building your app and learning the STRUDEL Tech Stack.
diff --git a/docs/docs/guides/tutorials/basic-app-with-strudel/7-continue-learning.md b/docs/docs/guides/tutorials/basic-app-with-strudel/7-continue-learning.md
@@ -1,5 +1,10 @@
 # Continue Learning
 
+:::warning
+
+This tutorial was written for v0.0.2 through v0.0.9 of strudel-kit. It is currently in the process of being updated for v0.1.0. 
+:::
+
 Congratulations on building your first STRUDEL app! You are well on your way to creating a product that is usable, understandable, and impactful. Of course, the journey does not end here. Below you will find a curated list of resources to continue building on what you learned in this tutorial.
 
 ### STRUDEL
@@ -23,10 +28,4 @@ Congratulations on building your first STRUDEL app! You are well on your way to
 
 ### Data Visualization
 
-- [Plotly in React](https://plotly.com/javascript/react/)
-
-## You've reached the end!
-
-Previous           |  &nbsp;
-:-------------------------:|:-------------------------:
-[Customize the Home Page](https://github.com/strudel-science/strudel-kit/blob/main/docs/getting-started/6-customize-home-page.md)  |  &nbsp;
+- [Plotly in React](https://plotly.com/javascript/react/)