From 8ab6abaac229199e840b93e9a86f368e2c6b0d55 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sun, 25 Apr 2021 16:47:26 +0100 Subject: [PATCH] Updated 1.2. Root Files (markdown) --- 1.2.-Plugin-Source-(`src-`).md | 19 +++++++++++++++++++ 1.2.-Root-Files.md | 16 ---------------- 2 files changed, 19 insertions(+), 16 deletions(-) create mode 100644 1.2.-Plugin-Source-(`src-`).md delete mode 100644 1.2.-Root-Files.md diff --git a/1.2.-Plugin-Source-(`src-`).md b/1.2.-Plugin-Source-(`src-`).md new file mode 100644 index 0000000..a670083 --- /dev/null +++ b/1.2.-Plugin-Source-(`src-`).md @@ -0,0 +1,19 @@ +# Plugin Source Root Files + +| File Name | Description | +|------|-------------| +| `footnotes.php` | The Plugin entry point. | +| `includes.php` | Includes all of the PHP files. | +| `license.txt` | The license under which the Plugin is released. | +| `readme.txt` | The Plugin readme for display on the WordPress Plugin Directory. | + +# Plugin Source Root Directories + +| Dir. Name | Description | +|------|-------------| +| `class/` | Contains the Plugin PHP code, providing most of its functionality. | +| `css/` | Contains the Plugin stylesheets. | +| `img/` | Contains images used by the Plugin (@todo can this be merged with the root `assets/` dir?). | +| `js/` | Contains JavaScript files used by the Plugin. | +| `languages/` | Contains Plugin translation files for various languages. | +| `templates/` | Contains HTML template files used by the Plugin to render various page elements. | \ No newline at end of file diff --git a/1.2.-Root-Files.md b/1.2.-Root-Files.md deleted file mode 100644 index de623de..0000000 --- a/1.2.-Root-Files.md +++ /dev/null @@ -1,16 +0,0 @@ -| File Name | Description | -|------|-------------| -| `CHANGELOG.md` | The full project changelog. | -| `CODE_OF_CONDUCT.md` | The project CoC. | -| `composer.json` & `composer.lock` | Declares Composer dependencies and scripts. | -| `CONTRIBUTING.md` | A guide to contributing to the project. | -| `LICENSE` | The license under which the project is released. | -| `package.json` & `package-lock.json` | Declares NPM dependencies and scripts. | -| `README.md` | Provides an overview of the project. | -| `SECURITY.md` | Provides guidance on reporting security-related issues. | -| `wpml-config.xml` | Used by the [WPML Plugin](https://wpml.org/documentation/support/language-configuration-files/) for translation. | -| `.distignore` | Lists files to ignore when building the Plugin for distribution (@todo this is not currently used). | -| `.eslintignore` & `.eslintrc.js` | Config. files for JavaScript linting. | -| `.gitignore` | Lists files to exclude from Git version control. | -| `.prettierignore` & `.prettierrc` | Config. files for JavaScript formatting. | -| `.stylelintignore` & `.stylelinttc.json` | Config. files for stylesheet linting. | \ No newline at end of file