📝 docs: writing documents for initilization and auditing

creating docs and writing

Author: jebarpg

package.json

@@ -142,84 +142,85 @@
         ".eslintignore",
         ".eslintrc.json",
         ".gitignore",
-        ".prettierrc.json",
         ".prettierignore",
+        ".prettierrc.json",
         "license",
+        "readme-api.md",
         "readme.md",
-        "commit-template.hbs",
         "commitlint.config.ts",
-        "readme-api.md",
-        "jest.config.json",
         "default-template.hbs",
+        "jest.config.json",
         "package-lock.json",
         "package.json",
-        "release.config.ts",
+        "commit-template.hbs",
         "renovate.json",
+        "release.config.ts",
         "tsconfig.json",
         "typedoc.json",
-        "public/.gitkeep",
         ".vscode/settings.json",
+        "public/.gitkeep",
         "repo_management_files/auditchecklist.md",
         "repo_management_files/branchnamingconventions.md",
         "repo_management_files/cz-emoji-template-extract.js",
         "repo_management_files/cz-emoji-type-extract.js",
         "repo_management_files/cz-type-extract.js",
-        "repo_management_files/directorystructuredocument.md",
         "repo_management_files/errorswarningsresolutions.md",
         "repo_management_files/extractfilescopes.js",
         "repo_management_files/fileswithgitmojis.md",
         "repo_management_files/genericcommitmessages.md",
-        "repo_management_files/gitmojisemver-extract.js",
+        "repo_management_files/directorystructuredocument.md",
+        "repo_management_files/initializationinfo.md",
         "repo_management_files/issues.sh",
+        "repo_management_files/gitmojisemver-extract.js",
         "repo_management_files/labels.sh",
         "repo_management_files/packagejsondocument.md",
         "repo_management_files/usefultipsandtricks.md",
-        ".github/dependabot.yml",
-        ".github/workflows/build.yml",
-        ".github/workflows/docs.yml",
-        ".github/workflows/lint.yml",
-        ".github/workflows/pr.yml",
-        ".github/workflows/release.yml",
-        ".github/workflows/test.yml",
-        ".github/workflows/depcheck.yml",
-        ".husky/commit-msg",
         ".husky/pre-commit",
         ".husky/prepare-commit-msg",
+        ".husky/commit-msg",
         ".husky/_/.gitignore",
         ".husky/_/applypatch-msg",
         ".husky/_/commit-msg",
         ".husky/_/h",
         ".husky/_/post-applypatch",
         ".husky/_/post-checkout",
-        ".husky/_/post-rewrite",
         ".husky/_/post-commit",
+        ".husky/_/post-merge",
+        ".husky/_/post-rewrite",
         ".husky/_/pre-applypatch",
         ".husky/_/pre-auto-gc",
-        ".husky/_/post-merge",
         ".husky/_/pre-commit",
         ".husky/_/pre-push",
         ".husky/_/pre-rebase",
         ".husky/_/prepare-commit-msg",
+        ".github/dependabot.yml",
+        ".github/workflows/build.yml",
+        ".github/workflows/depcheck.yml",
+        ".github/workflows/docs.yml",
+        ".github/workflows/lint.yml",
+        ".github/workflows/pr.yml",
+        ".github/workflows/release.yml",
+        ".github/workflows/test.yml",
         "src/app.ts",
         "src/bin/.gitkeep",
         "src/configs/.gitkeep",
+        "src/models/.gitkeep",
         "src/controllers/.gitkeep",
+        "src/middleware/.gitkeep",
         "src/plugins/.gitkeep",
         "src/routes/.gitkeep",
-        "src/middleware/.gitkeep",
         "src/utils/.gitkeep",
         "src/views/.gitkeep",
-        "src/models/.gitkeep",
         "test/.gitkeep",
         "test/app.test.ts",
-        "test/bin/.gitkeep",
         "test/configs/.gitkeep",
-        "test/middleware/.gitkeep",
         "test/controllers/.gitkeep",
+        "test/bin/.gitkeep",
+        "test/middleware/.gitkeep",
         "test/models/.gitkeep",
         "test/plugins/.gitkeep",
-        "test/utils/.gitkeep",
         "test/routes/.gitkeep",
+        "test/utils/.gitkeep",
         "test/views/.gitkeep"
       ],
       "questions": {

repo_management_files/auditChecklist.md

@@ -4,9 +4,10 @@ Some files I don't list such as .eslintrc.json or .gitignore even though they mi
 
 ## Files and Sections to review
 
-NOTE: You can click `file/paths` to open that file and referenced arrays to open and highlight that section of the file.
+NOTE: You can click `file/paths` to open that file and referenced arrays to open and highlight that section of the file. Note: some of the highlighted sections when you click on the `file/paths` may be out of sync when you start adding new scripts etc to your project. For now you have to manually update this file; in the future there will be a script to automatically update the line number in this file. (this NOTE was last updated 07/25/2024)
 
-- [ ] Run `bun dev:all` weekly on Sunday and fix any issues it reports.
+- [ ] Add more audits to this file if there are certain manual updates that need checking regularly. Use the following check lists to gain some intuition on what sort of things qualify as needing to be audited/tracked regularly.
+- [ ] Run [`bun dev:all`](../package.json#L80) weekly on Sunday and fix any issues it reports.
 - [ ] Make sure all workflows yaml files in [`../.github/workflows`](../.github/workflows/) have emoji's at the beginning of all their `name` sections. Consider using ***[ChatGPT](https://chatgpt.com/share/b54be984-4344-4e8f-bb56-c39595a52fa4)*** `Prompt: 'Generate an emoji to represent the following text: "Check out Git repository"'` to generate an emoji(s) for each `name` string.
 - [ ] [`.husky/pre-commit`](../.husky/pre-commit)
   - [ ] check to make sure you are running all the scripts you still want to have running during a pre-commit.

repo_management_files/initializationInfo.md

@@ -0,0 +1,9 @@
+# Initialization Information
+
+This file explains what each piece of information asked for in the [initialization script] {TODO: Update the bracket text with the actual initialization script file path once you create it.} is used for and which files it applies to as well as the specific fields that it affects in those files.
+
+## Required Information Descriptions
+
+
+- Project Name
+  - package.json "name": ""