Skip to content

Commit 0faf55a

Browse files
authored
Merge pull request #11 from githubuniverseworkshops/arilivigni/self-service-prompting
Refactor README and documentation structure
2 parents 44f27dc + 0de3f6d commit 0faf55a

26 files changed

+65
-18
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ Without further ado, let's get started.
2525

2626
## Table of Contents
2727

28-
1. [Story](docs/1_Story)
29-
2. [Prerequisites and development environment setup](docs/2_Prerequisites)
30-
3. [Getting started - app frontend and backend creation](docs/3_GettingStarted)
31-
4. [OctoFit Tracker database and app backend setup](docs/4_BackendSettings)
32-
5. [Populate the database with sample data](docs/5_PopulateDBwData)
28+
1. [The OctoFit Tracker app story](docs/1_Story/README.md)
29+
2. [Prerequisites and asetup of the development environment](docs/2_Prerequisites/README.md)
30+
3. [Getting started - app frontend and backend creation](docs/3_GettingStarted/README.md)
31+
4. [The OctoFit Tracker database and app backend creation](docs/4_BackendSettings/README.md)
32+
5. [Populate the database with sample data](docs/5_PopulateDBwData/README.md)
33+
6. [Using the Codespace endpoint to access the Django REST Framework](docs/6_CodespaceDjangoRESTFramework/README.md)

docs/1_Story/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Your journey to develop a fitness tracker app with GitHub Copilot now begins!
1+
# The OctoFit Tracker app story
22

33
![OctoFit Tracker](../../images/octofit-tracker.png)
44

@@ -105,4 +105,4 @@ Join us for this exciting journey into the future of software development, where
105105

106106
In this workshop, you are going to assume to be the lead developer. You will be responsible for building the application with GitHub Copilot’s help. Good luck!
107107

108-
[Next: Prerequisite and setup of the development environment](../2_Prerequisites)
108+
[Next: Prerequisite and setup of the development environment](../2_Prerequisites/README.md)

docs/2_Prerequisites/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ When the codespace is created you may get the following message for the GitHub C
3838
- If you choose this option we recommend using VSCode as your IDE, but this workshop is not limited to VSCode
3939
- URL for REACT and Django will be `http://localhost` or `http://127.0.0.1`
4040

41-
[Back :: Previous: Story](../1_Story) | [Next :: Getting started](../3_GettingStarted/)
41+
[Back :: Previous: The OctoFit Tracker app story](../1_Story/README.md) | [Next :: Getting started - app frontend and backend creation](../3_GettingStarted/README.md)

docs/3_GettingStarted/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Getting started
1+
# Getting started - app frontend and backend creation
22

33
In this section, we will start by setting up the face of our OctoFit application by building the front end page. To do that, we will keep it as simple as possible for now. We need resources like HTML and CSS to start decorating first, and we will later modify the page to extend the functionalities.
44

@@ -75,4 +75,4 @@ Important to avoid using public code and we do NOT need to initialize the git re
7575

7676
![octofit-tracker app directory tree](./3_3_OctoFitTrackerDirTree.png)</br>
7777

78-
[Back :: Previous: Prerequisites and development environment setup](../2_Prerequisites) | [Next :: OctoFit Tracker database and app backend setup](../4_BackendSettings/)
78+
[Back :: Previous: Prerequisites and development environment setup](../2_Prerequisites/README.md) | [Next :: The OctoFit Tracker database and app backend creation](../4_BackendSettings/README.md)
57.7 KB
Loading
Binary file not shown.
111 KB
Loading
158 KB
Loading
86.3 KB
Loading
165 KB
Loading

0 commit comments

Comments
 (0)