diff --git a/docs/code-standards.md b/docs/code-standards.md new file mode 100644 index 0000000..6f58498 --- /dev/null +++ b/docs/code-standards.md @@ -0,0 +1,66 @@ +# Code standards + +How code in this theme is written and why. The goal is predictability — both for humans reading the diff and for LLM-driven tooling navigating the repo. + +## File naming + +- **Kebab-case** for all filenames: `link-button.html`, `theme-toggle.js`, `schema-website.html`. +- Long descriptive names beat short cryptic ones — `analytics-loader.html` is better than `al.html`. +- Hugo partials living under `layouts/partials/` use the `.html` extension even when they emit JSON-LD or `