v3.18.0

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release Notes
 
+## 3.18.0 (2021-10-24)
+
+### What's new
+- Add license file. #154 by @robdekort
+- Add conributing file. #155 by @robdekort
+
+### What's improved
+- Add missing IDE helper comments to various partials. #151 by @robdekort
+
 ## 3.17.0 (2021-10-24)
 
 ### What's new

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing
+Contributions and discussions are always welcome, no matter how large or small.
+
+Statamic Peak is a mono repo containing the kit that gets installed for users, a development environment and the docs.
+
+## Repo structure
+
+| Location | Purpose |
+| --- | --- |
+| `/` | The root level contains the actual kit that gets installed by Statamic. |
+| `/docs/` | The documentation auto deployed to [peak.studio1902.nl](https://peak.studio1902.nl) running on Netlify. |
+| `/dev/` | The actual development environment. A running Statamic Peak instance. |
+
+## Development environment
+If you want to contribute to the core Starter Kit **make sure you update the files in the `dev` folder of the repository**.
+After making changes please run a local starter kit install from this folder to check everything installs properly.
+
+When you use valet you can navigate to the `dev` folder and type: `valet link statamic-peak`.
+After this your site will be available on `http://statamic-peak.test` (or whatever you configured for your TLD).
+
+## Test the kit export
+You can test the kit export by running `php please starter-kit:export .././` in the dev environment. After running this command the git status should reflect all changed and new files in the root of the repo. Please don't commit those kit export changes. Exporting the starter kit, maintaining the changelog and taggin releases is something the maintainer(s) of the project do.
+
+## Docs
+The documentation run on https://vuepress.vuejs.org. To locally install this navigate to the `docs` dir in this repo and:
+
+1. `npm i`
+2. `npm run docs:dev`
+3. Visit http://localhost:8080.
+
+Commits to these docs are automatically deployed to production on https://peak.studio1902.nl using [Netlify](https://netlify.com).

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Studio 1902
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dev/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Release Notes
 
-## Unreleased
+## 3.18.0 (2021-10-24)
 
 ### What's new
 - Add license file. #154 by @robdekort

resources/views/navigation/_breadcrumbs.antlers.html

@@ -2,6 +2,7 @@
 	@name Breadcrumbs
 	@desc Breadcrumbs display the current page in it's page hierarcy.
 #}}
+
 <nav aria-label="breadcrumb">
     <ol
         vocab="https://schema.org/"

resources/views/navigation/_main.antlers.html

@@ -1,6 +1,6 @@
 {{#
 	@name Main navigation
-	@desc The sites main navigation rendered on each page. It's 2 levels deep by default and uses AlpineJS for interactivity. There's a desktop and a mobile version.
+	@desc The sites main navigation rendered on each page. There's a desktop and a mobile version.
 #}}
 
 {{# The desktop navigation. Hidden on smaller screen. Shown from md and up. #}}

resources/views/navigation/_main_desktop.antlers.html

@@ -1,3 +1,8 @@
+{{#
+	@name Main desktop navigation
+	@desc The sites main desktop navigation rendered on each page. It's 2 levels deep by default and uses AlpineJS for interactivity.
+#}}
+
 <nav class="hidden md:block">
     <ul class="flex items-center space-x-8">
         {{ nav:main max_depth="2" include_home="true" }}

resources/views/navigation/_main_mobile.antlers.html

@@ -1,3 +1,8 @@
+{{#
+	@name Main mobile navigation
+	@desc The sites main mobile navigation rendered on each page. It's 2 levels deep by default and uses AlpineJS for interactivity.
+#}}
+
 <nav
     x-data="{ mobileNavOpen: false }"
     x-trap="mobileNavOpen"

resources/views/navigation/_skip_to_content.antlers.html

@@ -1,3 +1,8 @@
+{{#
+	@name Skip to content button
+	@desc The first button that pops up when a user tabs. This enables them to skip directly to the content.
+#}}
+
 <a class="fixed bottom-safe left-8 py-2 px-4 bg-primary text-white text-sm rounded shadow-lg font-bold translate-y-24 opacity-0 focus-visible:translate-y-0 focus-visible:opacity-100 motion-safe:transition-all" href="#content" tabindex="1">
     {{ trans:strings.skip_to_content }}
 </a>

starter-kit.yaml

@@ -52,6 +52,8 @@ export_paths:
   - resources/users/roles.yaml
   - resources/views
   - routes/web.php
+  - CONTRIBUTING.md
+  - LICENSE
   - package.json
   - package-lock.json
   - README.example.md