Code Quality: Document entire repository

builds/README.md

@@ -0,0 +1,3 @@
+# `builds`
+
+This folder contains Files build pipelines that are used by Azure DevOPS to seamlessly build the app and deploy it.

src/Files.App (Package)/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App (Package)`
+
+This folder contains the Windows Application Packaging project that is used to deploy Files as an MSIX file and package it for association with the Microsoft Store.

src/Files.App.BackgroundTasks/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App.BackgroundTasks`
+
+This folder contains the very small project `Files.App.BackgroundTasks` which exposes a `UpdateTask` class that deletes log files and "refreshes" the app.

src/Files.App.Controls/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App.Controls`
+
+This folder contains the project that hosts Files built-in controls for the app such as `ThemedIcon`.

src/Files.App.CsWin32/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App.CsWin32`
+
+This folder contains Win32 low-level API bridges for Files such as COM helpers.

src/Files.App.Launcher/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App.Launcher`
+
+This folder contains a Microsoft Visual C++ project that allows for easy opening and launching of Files with arguments.

src/Files.App.OpenDialog/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App.OpenDialog`
+
+This folder contains a Microsoft Visual C++ project that allows the user to set Files as the open dialog in Windows.

src/Files.App.SaveDialog/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App.SaveDialog`
+
+This folder contains a Microsoft Visual C++ project that allows setting Files as the user's save file dialog in Windows.

src/Files.App.Server/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App.Server`
+
+This project contains code that exposes an API for detecting the app's state.

src/Files.App.Storage/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App.Storage`
+
+This folder contains interfaces and APIs that unify Files's approach to utilising files and folders in Windows.

src/Files.App/Extensions/README.md

@@ -0,0 +1,23 @@
+# `src/Files.App/Extensions`
+
+This folder contains extension classes that provide methods for performing operations such as localization and string manipulation.
+
+---
+
+For example, it contains the source file `Fractions.cs` which allows for converting double values into fractions.
+It also contains `LocalizationExtensions.cs` which allows the developer to insert a string with the following format:
+
+```cs
+using Files.App.Extensions;
+
+namespace Files.Example;
+
+class Program
+{
+    static void Main(string[] args)
+    {
+        private string _exampleResource
+            => "ExampleStringID".ToLocalized();
+    }
+}
+```

src/Files.App/Helpers/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App/Helpers`
+
+This folder contains helpers for performing operations across the app.

src/Files.App/Properties/PublishProfiles/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App/Properties/PublishProfiles`
+
+This folder is created by Visual Studio to contain properties for building the app.

src/Files.App/Properties/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App/Properties`
+
+This folder is created by Visual Studio to contain properties for building the app. See [`PublishProfiles`](https://github.com/files-community/Files/blob/main/src/Files.App/Properties/PublishProfiles/README.md) for more info.

src/Files.App/README.md

@@ -0,0 +1,4 @@
+# `src/Files.App`
+
+This WinUI3/WinAppSdk project contains the core source for Files and the application definition. Most of the app's processes and core code is stored here, especially the UI.
+Files uses the MVVM app model, and code style for developing the app can be found [here](https://files.community/docs/contributing/code-style).

src/Files.App/Services/README.md

@@ -0,0 +1,4 @@
+# `src/Files.App/Services`
+
+This folder contains services for keeping a standardized way of performing actions across the app.
+It also contains compatibility helpers that assist with allowing the app to interact with 3rd party extensions such as QuickLook.

src/Files.App/Strings/README.md

@@ -0,0 +1,12 @@
+# `src/Files.App/Strings`
+
+These are the translation/i18n resources for Files.
+
+---
+
+Currently, Crowdin translation is implemented to manage the translation resources for Files. Therefore, you are strongly encouraged, if not required, to translate exclusively on that platform.
+No matter how great, your translation PRs will be declined or rejected if you do not adhere to this.
+You can contribute easily at [crowdin.com/files](https://crowdin.com/project/files-app), which will ensure your translations are implemented.
+If a language is missing and you'd like to contribute a new one, feel free to ask in a new issue or via [the Files Discord server](https://discord.gg/files).
+
+Please also be aware of our [translation docs](https://files.community/docs/contributing/translating) which will assist you in translating the app if you are unsure how to do so. If you're unsure of the translation style you should employ, please ask a member of the Files Organization on [the Files Discord server](https://discord.gg/files).

src/Files.App/Styles/README.md

@@ -0,0 +1,8 @@
+# `src/Files.App/Styles`
+
+This directory contains styling information for XAML UI elements in Files.
+For example:
+
+- **ShimmerStyles.xaml**: Defines the styles for skeleton loading animations
+- **TextBlockStyles.xaml**: Specifies the text block appearance and styles
+- **StatusCenterStyles**: Contains theme definitions for the status center.

src/Files.App/UserControls/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App/UserControls`
+
+This folder contains adapted UI controls that Files uses for its design and experience.

src/Files.App/Utils/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App/Utils`
+
+This folder contains code for app UI utilities such as the status center experience, Git functionality, tags, and more.

src/Files.App/ViewModels/README.md

@@ -0,0 +1,4 @@
+# `src/Files.App/ViewsModels`
+
+This folder contains code that supports the UI.
+Considering that Files uses the MVVM app model, view models are stored here, views are stored [`Views`](https://github.com/files-community/Files/blob/main/src/Files.App/Views), and models are stored in [`Models`](https://github.com/files-community/Files/blob/main/src/Files.App/Views).

src/Files.App/Views/README.md

@@ -0,0 +1,4 @@
+# `src/Files.App/Views`
+
+This folder contains views and UI code for Files.
+Considering that Files uses the MVVM app model, views are stored here, models are stored in [`Models`](https://github.com/files-community/Files/blob/main/src/Files.App/Models), and view models are stored in [`ViewModels`](https://github.com/files-community/Files/blob/main/src/Files.App/ViewModels).

src/Files.App/nupkgs/README.md

@@ -0,0 +1,3 @@
+# `src/Files.App/nupkgs`
+
+This folder contains `nupkg` (NuGet package) files for use in Files, such as the API for 7Zip that is used by Files's archive process.

src/README.md

@@ -0,0 +1,3 @@
+# `src`
+
+This folder contains the core source code for the Files app.

tests/Files.App.UITests/README.md

@@ -0,0 +1,3 @@
+# `tests/Files.App.UITests`
+
+This contains the UI tests used to test the app's interface.

tests/Files.InteractionTests/README.md

@@ -0,0 +1,3 @@
+# `tests/Files.InteractionTests`
+
+This contains the core tests for application logic and code models.

tests/README.md

@@ -0,0 +1,3 @@
+# `tests`
+
+This folder contains test projects for the UI. This helps the Files Team easily review pull requests and check for accessibility issues.