Skip to content

Commit e7bcba8

Browse files
committed
Update contributing docs
1 parent 1897dd1 commit e7bcba8

3 files changed

Lines changed: 23 additions & 15 deletions

File tree

docs/README.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/docs/.vuepress/.temp/pages/other/contributing.html.vue

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<template><h1 id="contributing" tabindex="-1"><a class="header-anchor" href="#contributing" aria-hidden="true">#</a> Contributing</h1>
22
<p>Contributions and discussions are always welcome, no matter how large or small. Treat each other with respect. Read the <a href="https://github.com/studio1902/statamic-peak/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank" rel="noopener noreferrer">Code of Conduct<OutboundLink/></a>.</p>
3-
<p>Statamic Peak is a mono repo. If you want to contribute make sure you target files the <code>/dev/</code> folder and run your local install from this folder. When you use valet you can navigate to the folder and type: <code>valet link statamic-peak</code>.</p>
3+
<p>Statamic Peak is a mono repo containing both a development environment and the docs.</p>
44
<h2 id="repo-structure" tabindex="-1"><a class="header-anchor" href="#repo-structure" aria-hidden="true">#</a> Repo structure</h2>
55
<table>
66
<thead>
@@ -24,6 +24,16 @@
2424
</tr>
2525
</tbody>
2626
</table>
27+
<h2 id="development-environment" tabindex="-1"><a class="header-anchor" href="#development-environment" aria-hidden="true">#</a> Development environment</h2>
28+
<p>If you want to contribute to the core Starter Kit make sure you target files the <code>/dev/</code> folder and run your local install from this folder. When you use valet you can navigate to the folder and type: <code>valet link statamic-peak</code>.</p>
29+
<h2 id="docs" tabindex="-1"><a class="header-anchor" href="#docs" aria-hidden="true">#</a> Docs</h2>
30+
<p>The documentation run on https://vuepress.vuejs.org. To locally install this navigate to the <code>docs</code> dir in this repo and:</p>
31+
<ol>
32+
<li><code>npm i</code></li>
33+
<li><code>npm run docs:dev</code></li>
34+
<li>Visit http://localhost:8080.</li>
35+
</ol>
36+
<p>Commits to these docs are automatically deployed to production on https://peak.studio1902.nl using <a href="https://netlify.com" target="_blank" rel="noopener noreferrer">Netlify<OutboundLink/></a>.</p>
2737
<h2 id="thanks" tabindex="-1"><a class="header-anchor" href="#thanks" aria-hidden="true">#</a> Thanks</h2>
2838
<p>These docs are initially setup using VuePress 1 by <a href="https://github.com/robertguss/" target="_blank" rel="noopener noreferrer">Robert Guss<OutboundLink/></a>. Thank you so much! Today we run VuePress 2.</p>
2939
</template>

docs/docs/other/contributing.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributing
22
Contributions and discussions are always welcome, no matter how large or small. Treat each other with respect. Read the [Code of Conduct](https://github.com/studio1902/statamic-peak/blob/main/.github/CODE_OF_CONDUCT.md).
33

4-
Statamic Peak is a mono repo. If you want to contribute make sure you target files the `/dev/` folder and run your local install from this folder. When you use valet you can navigate to the folder and type: `valet link statamic-peak`.
4+
Statamic Peak is a mono repo containing both a development environment and the docs.
55

66
## Repo structure
77

@@ -11,6 +11,17 @@ Statamic Peak is a mono repo. If you want to contribute make sure you target fil
1111
| `/docs/` | The documentation auto deployed to [peak.studio1902.nl](https://peak.studio1902.nl) running on Netlify. |
1212
| `/dev/` | The actual development environment. A running Statamic Peak instance. |
1313

14+
## Development environment
15+
If you want to contribute to the core Starter Kit make sure you target files the `/dev/` folder and run your local install from this folder. When you use valet you can navigate to the folder and type: `valet link statamic-peak`.
16+
17+
## Docs
18+
The documentation run on https://vuepress.vuejs.org. To locally install this navigate to the `docs` dir in this repo and:
19+
20+
1. `npm i`
21+
2. `npm run docs:dev`
22+
3. Visit http://localhost:8080.
23+
24+
Commits to these docs are automatically deployed to production on https://peak.studio1902.nl using [Netlify](https://netlify.com).
1425

1526
## Thanks
1627
These docs are initially setup using VuePress 1 by [Robert Guss](https://github.com/robertguss/). Thank you so much! Today we run VuePress 2.

0 commit comments

Comments
 (0)