Skip to content

Commit 5288dbb

Browse files
committed
Add more clarity to getting started guides
1 parent 98c6caf commit 5288dbb

File tree

4 files changed

+16
-8
lines changed

4 files changed

+16
-8
lines changed

docs/getting-started.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@ composer create-project --prefer-dist laravel/laravel:^8.0 project-name
4444
You must set your webserver's document root to point to the `public` folder inside your Laravel project. Laravel Valet and Laravel Sail will do this automatically.
4545
:::
4646

47+
:::tip
48+
It can be helpful to tell Composer which version of PHP you're targeting. This is especially important in a development environment where your webserver's PHP version may be different than the CLI.
49+
50+
To do this run: `composer config platform.php 8.0` substituting `8.0` for whichever version you are using.
51+
52+
:::
53+
4754
**Configure your Laravel Project**
4855

4956
Now that you have a Laravel Project setup it is a good time to edit the values in your `.env` file to reflect your setup. The `APP_URL` and `DB_*` variables are particularly important.

docs/guides/using-graphql-astro.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For the purposes of this guide we are also going to disable any authentication r
1010

1111
## Create an Astro Site
1212

13-
Start the installer wizard
13+
Now we will create a new Astro site. You can perform this setup anywhere but it should be in a different directory than your Coilpack installation.
1414

1515
```
1616
npm create astro@latest
@@ -33,9 +33,10 @@ Do you plan to write TypeScript?
3333
Liftoff confirmed. Explore your project!
3434
```
3535

36-
Once the installation is complete you can start the live reload development server
36+
Once the installation is complete you can change into the Astro project directory and start the live reload development server.
3737

3838
```
39+
cd astro-project-folder
3940
npm run dev
4041
```
4142

docs/guides/using-graphql-gatsby.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ For the purposes of this guide we are also going to disable any authentication r
1010

1111
## Create a Gatsby Site
1212

13-
Create a new site (skipping the wizard questions)
13+
Now we will create a new Gatsby site. You can perform this setup anywhere but it should be in a different directory than your Coilpack installation.
1414

1515
```
1616
npm init gatsby my-coilpack-site -- -y
1717
```
1818

19-
Change into your new site's directory
19+
Change into your new Gatsby site's directory
2020

2121
```
2222
cd my-coilpack-site

docs/templates/tags/structure-nav.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ If you want to display a few levels of your tree it might be simplest and most s
2222
status: 'open|closed',
2323
show_depth: 2,
2424
}) %}
25-
<a href="{{ item.structure_url_title }}">{{ item.entry.title }}</a>
25+
<a href="{{ item.url }}">{{ item.entry.title }}</a>
2626
{% if item.children|length %}
2727
<ul>
2828
{% for child in item.children %}
2929
<li>
30-
<a href="{{ child.structure_url_title }}">{{ child.entry.title }}</a>
30+
<a href="{{ child.url }}">{{ child.entry.title }}</a>
3131
</li>
3232
{% endfor %}
3333
</ul>
@@ -43,12 +43,12 @@ If you want to display a few levels of your tree it might be simplest and most s
4343
status: 'open|closed',
4444
show_depth: 2,
4545
}) as $item)
46-
<a href="{{ $item['structure_url_title'] }}">{{ $item['entry']['title'] }}</a>
46+
<a href="{{ $item['url'] }}">{{ $item['entry']['title'] }}</a>
4747
@if(count(item.children))
4848
<ul>
4949
@foreach($item['children'] as $child)
5050
<li>
51-
<a href="{{ $child['structure_url_title'] }}">{{ $child['entry']['title'] }}</a>
51+
<a href="{{ $child['url'] }}">{{ $child['entry']['title'] }}</a>
5252
</li>
5353
@endforeach
5454
</ul>

0 commit comments

Comments
 (0)