Update convention lists

InteractionDesignFoundation · Jul 4, 2024 · 471bb98 · 471bb98
1 parent 2eb2ebd
commit 471bb98
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 25 deletions.
diff --git a/library/backend/README.md b/library/backend/README.md
@@ -2,10 +2,10 @@
 
 ## Table of Contents
 
+-   [IxDF conventions for PHP](conventions--php.md)
+-   [IxDF conventions for Laravel](conventions--laravel.md)
 -   [Clean Code Principles for PHP](clean-code-php.md)
 -   [S.O.L.I.D. Principles for PHP](SOLID.md)
--   [Our conventions for PHP](conventions--php.md)
--   [Our conventions for Laravel](conventions--laravel.md)
 -   [Literature](literature.md)
 
 🦄
diff --git a/library/backend/literature.md b/library/backend/literature.md
@@ -31,11 +31,11 @@ you may want to selectively sync those you want to study into your computer when
     1. Subscriptions
     1. Awesome lists
 
-# Frontend
+## Frontend
 
 Every back-end developer should have some front-end knowledge to have basic working skills & collaborate with front-end developers.
 
-## Foundations
+### Foundations
 
 1.  JS tutorial:
     [A re-introduction to JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript) -
@@ -49,17 +49,17 @@ Every back-end developer should have some front-end knowledge to have basic work
 1.  Topic: ITCSS/BEM methodology:
     [MindBEMding](https://csswizardry.com/2013/01/mindbemding-getting-your-head-round-bem-syntax/)
 
-For more frontend hints please see [🔒 frontend hints dir](https://github.com/InteractionDesignFoundation/IxDF-web/blob/main/docs/library/frontend/hints/).
+For more frontend hints, please see [🔒 frontend hints dir](https://github.com/InteractionDesignFoundation/IxDF-web/blob/main/docs/library/frontend/hints/).
 
-# Backend
+## Backend
 
 Every back-end developer should
 
 -   have a basic set of programming skills (Foundations),
 -   use evergreen programming principles and team conventions (References),
 -   be aware of modern techniques, tools, and APIs (Subscriptions and Awesome lists).
 
-## Foundations
+### Foundations
 
 1.  Classic programming (books): `Robert Martin - Clean Code - 2008` and/or
     `Steve McConnell - Code Complete, 2nd edition - 2014`.
@@ -84,29 +84,25 @@ Every back-end developer should
 1.  Optional: DDD (book): `Vernon V. - Domain-Driven Design Distilled - 2016`.
 1.  Optional: Articles inside `Articles` shared folder.
 
-# References
+## References
 
 1.  [Clean Code concepts adapted for PHP](clean-code-php.md)
 1.  [🔒 IxDF’s back-end conventions](https://github.com/InteractionDesignFoundation/IxDF-web/blob/main/docs/code/backend/conventions.md)
 
-# Subscriptions
+## Subscriptions
 
 1.  PHPStorm blog (including [PHP Annotated Monthly](https://blog.jetbrains.com/phpstorm/category/php-annotated-monthly/)
     digests):
     [![RSS](https://www.maldonadonoticias.com/beta/images/headers/rss-icon.gif)](https://blog.jetbrains.com/phpstorm/feed/)
     [https://blog.jetbrains.com/phpstorm](https://blog.jetbrains.com/phpstorm)
 1.  [Laracon EU](https://www.youtube.com/channel/UCb9XEo_1SDNR8Ucpbktrg5A) annual Laravel conference videos on YouTube.
-1.  A blog on Laravel & PHP:
-    [![RSS](https://www.maldonadonoticias.com/beta/images/headers/rss-icon.gif)](https://murze.be/feed) [https://murze.be](https://murze.be)
-1.  Laravel weekly newsletter:
+1.  Laravel news weekly newsletter:
     [![RSS](https://www.maldonadonoticias.com/beta/images/headers/rss-icon.gif)](https://feed.laravel-news.com/)
     [https://laravel-news.com](https://laravel-news.com)
-1.  Optional: Adam Wathan's blog (active Laravel developer)
-    [![RSS](https://www.maldonadonoticias.com/beta/images/headers/rss-icon.gif)](https://adamwathan.me/rss)
-    [https://adamwathan.me](https://adamwathan.me)
-1.  Optional: Taylor Otwell's Medium stories (Creator of Laravel): [@taylorotwell](https://medium.com/@taylorotwell)
+1.  Freek’s (from Spatie) blog on Laravel & PHP:
+    [![RSS](https://www.maldonadonoticias.com/beta/images/headers/rss-icon.gif)](https://freek.dev/feed) [https://freek.dev](https://freek.dev)
 
-# Awesome lists
+## Awesome lists
 
 Awesome lists are great starting points for any material you'd like to find: Documentation, articles, talks,
 tools, etc. All of them are community curated and always up to date 🌲.

diff --git a/library/frontend/README.md b/library/frontend/README.md
@@ -2,9 +2,11 @@
 
 ## Table of Contents
 
+-   [IxDF conventions for JavaScript](conventions--js.md)
+-   [IxDF conventions for JSDoc](conventions--jsdoc.md)
+-   [IxDF conventions for Vue](conventions--vue.md)
+-   [IxDF conventions for CSS](conventions--css.md)
 -   [Clean Code Principles for JavaScript](clean-code-js.md)
--   [Our conventions for JavaScript](conventions--js.md)
--   [Our conventions for CSS](conventions--css.md)
 -   [Literature](literature.md)
 
 🦄
diff --git a/library/frontend/literature.md b/library/frontend/literature.md
@@ -30,11 +30,11 @@ you may want to selectively sync those you want to study into your computer when
     1. Subscriptions
     1. Awesome lists
 
-# Backend
+## Backend
 
 Every frontend developer should have some backend knowledge to have basic working skills & collaborate with backend developers.
 
-## Foundations
+### Foundations
 
 1.  [Laravel Blade](https://laravel.com/docs/master/blade) - PHP template engine. Frontend developers should understand how to
     use `@extend`, `@include`, `@component`, `@section`, `@push`, `@foreach` and `@if` directives. They should also understand when they should use `{{ $variable }}` and `{!! $variable !!}` (display escaped/unescaped data).
@@ -46,14 +46,14 @@ Every frontend developer should have some backend knowledge to have basic workin
 
 For more back-end hints, please see [🔒 backend hints dir](https://github.com/InteractionDesignFoundation/IxDF-web/docs/code/backend/hints).
 
-# Frontend
+## Frontend
 
 Every frontend developer should
 
 -   have a basic set of programming skills (Foundations),
 -   be aware of modern techniques, tools, and APIs (Subscriptions and Awesome lists).
 
-## Foundations
+### Foundations
 
 1.  Classic programming skills: [Clean Code: JavaScript](clean-code-js.md):
     Software engineering principles, from Robert C. Martin's book Clean Code, adapted for JavaScript.
@@ -69,7 +69,7 @@ Every frontend developer should
     [KISS, YAGNI & DRY Principles](https://code.tutsplus.com/tutorials/3-key-software-principles-you-must-understand--net-25161)
 1.  Optional: Network (book): [Ilya Grigorik - High Performance Browser Networking](https://hpbn.co/).
 
-# Subscriptions
+## Subscriptions
 
 It’s very useful to subscribe to some weekly newsletters or podcasts and be aware of all the events and news in the front-end world.
 
@@ -84,7 +84,7 @@ It’s very useful to subscribe to some weekly newsletters or podcasts and be aw
     [![RSS](https://www.maldonadonoticias.com/beta/images/headers/rss-icon.gif)](https://inclusive-components.design/rss/)
     https://inclusive-components.design/
 
-# Awesome lists
+## Awesome lists
 
 Awesome lists are great starting points for any material you'd like to find: Documentation, articles, talks,
 tools, etc. All of them are community curated and always up to date 🌲.