From 6a772043ab583e2e47cdab459672d805a6fae8bc Mon Sep 17 00:00:00 2001 From: Marc Beinder <50760632+onairmarc@users.noreply.github.com> Date: Tue, 30 Jul 2024 10:53:54 -0500 Subject: [PATCH] Restructure the Style Guide for Docs Site (#4) --- README.md | 2 +- guides/{lang/php.md => Language/PHP.md} | 4 ++++ guides/{lang/sql.md => Language/SQL.md} | 4 ++++ guides/README.md | 14 +++++++++----- guides/{tools/git.md => Tools/Git.md} | 4 ++++ .../dependabot.md => Tools/GitHub/Dependabot.md} | 4 ++++ guides/common.md | 4 ++++ 7 files changed, 30 insertions(+), 6 deletions(-) rename guides/{lang/php.md => Language/PHP.md} (98%) rename guides/{lang/sql.md => Language/SQL.md} (98%) rename guides/{tools/git.md => Tools/Git.md} (98%) rename guides/{tools/github/dependabot.md => Tools/GitHub/Dependabot.md} (99%) diff --git a/README.md b/README.md index 3c5d75f..3f05dce 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ If you've arrived here, you're probably thinking, "Great, yet another company is ### Language-Specific Style Guides -[PHP Style Guide](/guides/lang/php.md) +[PHP Style Guide](/guides/Language/PHP.md)



![](/img/the-code-is-more-like-guidelines.jpg) diff --git a/guides/lang/php.md b/guides/Language/PHP.md similarity index 98% rename from guides/lang/php.md rename to guides/Language/PHP.md index bea7710..bb8a3ba 100644 --- a/guides/lang/php.md +++ b/guides/Language/PHP.md @@ -1,3 +1,7 @@ +--- +title: PHP +--- + # PHP Language Style Guide ## Overview diff --git a/guides/lang/sql.md b/guides/Language/SQL.md similarity index 98% rename from guides/lang/sql.md rename to guides/Language/SQL.md index f1b80d2..2195324 100644 --- a/guides/lang/sql.md +++ b/guides/Language/SQL.md @@ -1,3 +1,7 @@ +--- +title: SQL +--- + # SQL Language Style Guide ## Overview diff --git a/guides/README.md b/guides/README.md index 1b27bb7..cb16f32 100644 --- a/guides/README.md +++ b/guides/README.md @@ -1,4 +1,8 @@ -# Style Guide Table of Contents +--- +title: Overview +--- + +# Style Guide Overview ## General Style Guides @@ -6,10 +10,10 @@ ## Language-Specific Style Guides -- [PHP Language Style Guide](./lang/php.md) -- [SQL Language Style Guide](./lang/sql.md) +- [PHP Language Style Guide](./Language/PHP.md) +- [SQL Language Style Guide](./Language/PHP.md) ## Tool Specific Guides -- [Git Style Guide](./tools/git.md) -- [GitHub Dependabot](./tools/github/dependabot.md) +- [Git Style Guide](./Tools/Git.md) +- [GitHub Dependabot](./Tools/GitHub/Dependabot.md) diff --git a/guides/tools/git.md b/guides/Tools/Git.md similarity index 98% rename from guides/tools/git.md rename to guides/Tools/Git.md index 828ccc3..df84409 100644 --- a/guides/tools/git.md +++ b/guides/Tools/Git.md @@ -1,3 +1,7 @@ +--- +title: Git Style Guide +--- + # Git Style Guide ## Overview diff --git a/guides/tools/github/dependabot.md b/guides/Tools/GitHub/Dependabot.md similarity index 99% rename from guides/tools/github/dependabot.md rename to guides/Tools/GitHub/Dependabot.md index 830254f..cfa0123 100644 --- a/guides/tools/github/dependabot.md +++ b/guides/Tools/GitHub/Dependabot.md @@ -1,3 +1,7 @@ +--- +title: Dependabot +--- + # GitHub Dependabot Guide ## Overview diff --git a/guides/common.md b/guides/common.md index c64547e..9472e90 100644 --- a/guides/common.md +++ b/guides/common.md @@ -1,3 +1,7 @@ +--- +title: Common Style Guide +--- + # Common Language Style Guide ## Capitalization