docs: Refactor project-structure, add "scriptlets" entry

anfragment · Feb 3, 2025 · abc9e9f · abc9e9f
1 parent ccfb80c
commit abc9e9f
Showing 1 changed file with 13 additions and 9 deletions.
diff --git a/docs/internal/project-structure.md b/docs/internal/project-structure.md
@@ -1,14 +1,18 @@
 # Project structure
+
 This document describes the file structure of the project.
-- `.github`: Contains GitHub Actions workflows and issue templates.
-- `assets`: Contains assets used in README.md and other documents (no source files).
-- `build`: Contains build configuration and artifacts. Read more in [build/README.md](../../build/README.md).
-- `docs/internal`: Contains internal documentation for contributors.
-- `frontend`: Contains the frontend code. Read more in [frontend/README.md](../../frontend/README.md).
-- `internal`: Contains the backend Go packages.
-- `proxy`: Contains proxy exclusions for backward compatibility purposes. Read more in [proxy/README.md](../../proxy/README.md).
-- `scripts`: Node.js scripts for manifest file upload. Might be used for other purposes in the future.
-- `tasks`: Contains platform-specific build-related [taskfiles](https://taskfile.dev).
+
+- `.github`: GitHub Actions workflows and issue templates.
+- `assets`: Assets used in README.md and other documents (not in source files).
+- `build`: Build configuration and artifacts. Read more in [build/README.md](../../build/README.md).
+- `docs/internal`: Internal documentation for contributors.
+- `docs/external`: External documentation for users.
+- `frontend`: Frontend JS/TS code. Read more in [frontend/README.md](../../frontend/README.md).
+- `internal`: Backend Go packages.
+- `proxy`: Hosts excluded from proxying. Read more in [proxy/README.md](../../proxy/README.md).
+- `scriptlets`: JS/TS functions injected into webpages for advanced content blocking.
+- `scripts`: Node.js scripts for manifest file uploads. May be used for other purposes in the future.
+- `tasks`: Platform-specific build-related [Taskfiles](https://taskfile.dev).
 - `main.go`: The main entry point of the application.
 - `golangci.yml`: Configuration file for [golangci-lint](https://golangci-lint.run).
 - `Taskfile.yml`: Main [Taskfile](https://taskfile.dev) for common development tasks.