From d79d268a5a4a10e20135802a45b71928865af515 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:30:08 +0100 Subject: [PATCH 01/28] Write docs for `builds` --- builds/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 builds/README.md diff --git a/builds/README.md b/builds/README.md new file mode 100644 index 000000000000..d2f834679ce8 --- /dev/null +++ b/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. From bfaca8ad5d45d3a8e7f123dfe9974595afe4dfcc Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:31:38 +0100 Subject: [PATCH 02/28] Write docs for `tests` --- tests/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 tests/README.md diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 000000000000..1961b9bd93f2 --- /dev/null +++ b/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. From 76be90d42c82bb247a9fda0705b6651d34c779ad Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:32:37 +0100 Subject: [PATCH 03/28] Write docs for `tests/Files.App.UITests` --- tests/Files.App.UITests/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 tests/Files.App.UITests/README.md diff --git a/tests/Files.App.UITests/README.md b/tests/Files.App.UITests/README.md new file mode 100644 index 000000000000..2c39d6d7cf6f --- /dev/null +++ b/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. From a0890ae2fcdc5d52232ace7f560fb70ab05d9047 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:33:50 +0100 Subject: [PATCH 04/28] Write docs for `tests/Files.InteractionTests` --- tests/Files.InteractionTests/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 tests/Files.InteractionTests/README.md diff --git a/tests/Files.InteractionTests/README.md b/tests/Files.InteractionTests/README.md new file mode 100644 index 000000000000..f8a55aaddd4b --- /dev/null +++ b/tests/Files.InteractionTests/README.md @@ -0,0 +1,3 @@ +# `tests/Files.InteractionTests` + +This contains the core tests for application logic and code models. From 89ac3f75ea852a5a4852d2a47793b9dd297b2c3b Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:35:22 +0100 Subject: [PATCH 05/28] Write docs for `src/Files.App (Package)` --- src/Files.App (Package)/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App (Package)/README.md diff --git a/src/Files.App (Package)/README.md b/src/Files.App (Package)/README.md new file mode 100644 index 000000000000..f0a71f52a7d7 --- /dev/null +++ b/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. From 81078d244956229698ad12fcbd527cf1a1d28c9b Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:38:56 +0100 Subject: [PATCH 06/28] Write docs for `src/Files.App.BackgroundTasks` --- src/Files.App.BackgroundTasks/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App.BackgroundTasks/README.md diff --git a/src/Files.App.BackgroundTasks/README.md b/src/Files.App.BackgroundTasks/README.md new file mode 100644 index 000000000000..9b8c7a9929d6 --- /dev/null +++ b/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. From 4ea550c597cfc440c4f7bc016b6e5140b67b6a8f Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:40:07 +0100 Subject: [PATCH 07/28] Write docs for `src/Files.App.Controls` --- src/Files.App.Controls/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App.Controls/README.md diff --git a/src/Files.App.Controls/README.md b/src/Files.App.Controls/README.md new file mode 100644 index 000000000000..a8b9b028a6f3 --- /dev/null +++ b/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`. From 35a8aeb381fc3509c4ccd050843d3d0ef30645cc Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:43:59 +0100 Subject: [PATCH 08/28] Write docs for `src/Files.App.CsWin32` --- src/Files.App.CsWin32/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App.CsWin32/README.md diff --git a/src/Files.App.CsWin32/README.md b/src/Files.App.CsWin32/README.md new file mode 100644 index 000000000000..bb9cfeea67fa --- /dev/null +++ b/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. From 79cfe02e7c9106495383f83ef41b8d7200c159bf Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:46:39 +0100 Subject: [PATCH 09/28] Write docs for `src/Files.App.Launcher` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I barely know C++ so whatever I wrote is totally wrong 😭 --- src/Files.App.Launcher/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App.Launcher/README.md diff --git a/src/Files.App.Launcher/README.md b/src/Files.App.Launcher/README.md new file mode 100644 index 000000000000..cf3ecc3d8300 --- /dev/null +++ b/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. From 6606103b6be166b477969769f5f8146f44711ff8 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:47:30 +0100 Subject: [PATCH 10/28] Write docs for `src/Files.App.OpenDialog` --- src/Files.App.OpenDialog/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App.OpenDialog/README.md diff --git a/src/Files.App.OpenDialog/README.md b/src/Files.App.OpenDialog/README.md new file mode 100644 index 000000000000..f139359a7677 --- /dev/null +++ b/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. From 5c52c676d205c7c5d16ddddcd0cb805e4454794e Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:48:23 +0100 Subject: [PATCH 11/28] Write docs for `src/Files.App.SaveDialog` --- src/Files.App.SaveDialog/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App.SaveDialog/README.md diff --git a/src/Files.App.SaveDialog/README.md b/src/Files.App.SaveDialog/README.md new file mode 100644 index 000000000000..fbf8ec92f0a5 --- /dev/null +++ b/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. From 24f08957972a8cc22c17851aab5c6f94f7c6c387 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:50:39 +0100 Subject: [PATCH 12/28] Write docs for `src/Files.App.Server` --- src/Files.App.Server/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App.Server/README.md diff --git a/src/Files.App.Server/README.md b/src/Files.App.Server/README.md new file mode 100644 index 000000000000..c45ad5f833df --- /dev/null +++ b/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. From 3261359a3fa3464797ac0fd00cc245b2fea19ec4 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:51:48 +0100 Subject: [PATCH 13/28] Write docs for `src/Files.App.Storage` --- src/Files.App.Storage/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App.Storage/README.md diff --git a/src/Files.App.Storage/README.md b/src/Files.App.Storage/README.md new file mode 100644 index 000000000000..41521d1b0ca6 --- /dev/null +++ b/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. From 5e8e285c85daa7b41a43373b3faf5dd066215ca8 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:52:33 +0100 Subject: [PATCH 14/28] Write docs for `src` --- src/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/README.md diff --git a/src/README.md b/src/README.md new file mode 100644 index 000000000000..8552382af414 --- /dev/null +++ b/src/README.md @@ -0,0 +1,3 @@ +# `src` + +This folder contains the core source code for the Files app. From 90a56f0452ca807300c5f9d74a2e534a6b4782fc Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:54:47 +0100 Subject: [PATCH 15/28] Write docs for `src/Files.App` --- src/Files.App/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 src/Files.App/README.md diff --git a/src/Files.App/README.md b/src/Files.App/README.md new file mode 100644 index 000000000000..7176206ca38e --- /dev/null +++ b/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). From 1e8b7bbf7aaea89d76779639c6aff0a27b16c736 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:56:09 +0100 Subject: [PATCH 16/28] Write docs for `src/Files.App/nupkgs` --- src/Files.App/nupkgs/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App/nupkgs/README.md diff --git a/src/Files.App/nupkgs/README.md b/src/Files.App/nupkgs/README.md new file mode 100644 index 000000000000..1e873ccc245f --- /dev/null +++ b/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. From 126dda2f384ee27aaeb954cc0df3f3a01a789463 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 18:58:03 +0100 Subject: [PATCH 17/28] Write docs for `src/Files.App/Views` --- src/Files.App/Views/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 src/Files.App/Views/README.md diff --git a/src/Files.App/Views/README.md b/src/Files.App/Views/README.md new file mode 100644 index 000000000000..3113e89d1d29 --- /dev/null +++ b/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`](Models), and view models are stored in [`ViewModels`](ViewModels). From 46b502c5f6e91396c3bfe24d3f806b83e149dbe7 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 19:01:20 +0100 Subject: [PATCH 18/28] Write docs for `src/Files.App/ViewsModels` --- src/Files.App/ViewModels/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 src/Files.App/ViewModels/README.md diff --git a/src/Files.App/ViewModels/README.md b/src/Files.App/ViewModels/README.md new file mode 100644 index 000000000000..ecb490edee89 --- /dev/null +++ b/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). From fa762bbeca6657f16e7d690be8f369aaf0a7311b Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 19:02:07 +0100 Subject: [PATCH 19/28] Fix error(s) in docs for `src/Files.App/Views` --- src/Files.App/Views/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Files.App/Views/README.md b/src/Files.App/Views/README.md index 3113e89d1d29..49da914f91ef 100644 --- a/src/Files.App/Views/README.md +++ b/src/Files.App/Views/README.md @@ -1,4 +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`](Models), and view models are stored in [`ViewModels`](ViewModels). +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). From 0332c867e53f965a62e149f62ecdf8eebf3711e3 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 19:03:28 +0100 Subject: [PATCH 20/28] Write docs for `src/Files.App/Utils` --- src/Files.App/Utils/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App/Utils/README.md diff --git a/src/Files.App/Utils/README.md b/src/Files.App/Utils/README.md new file mode 100644 index 000000000000..4fa9cf04b1b0 --- /dev/null +++ b/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. From 133c0514a9e47e4c41fc53105ae782178307489c Mon Sep 17 00:00:00 2001 From: Lamparter Date: Thu, 17 Oct 2024 19:04:21 +0100 Subject: [PATCH 21/28] Write docs for `src/Files.App/UserControls` --- src/Files.App/UserControls/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App/UserControls/README.md diff --git a/src/Files.App/UserControls/README.md b/src/Files.App/UserControls/README.md new file mode 100644 index 000000000000..5a1df784af0e --- /dev/null +++ b/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. From 31739b95eb0259362d8f58ebfad290448adaa118 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Fri, 18 Oct 2024 07:43:15 +0100 Subject: [PATCH 22/28] Write docs for `src/Files.App/Styles` --- src/Files.App/Styles/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 src/Files.App/Styles/README.md diff --git a/src/Files.App/Styles/README.md b/src/Files.App/Styles/README.md new file mode 100644 index 000000000000..a1f19979cc4a --- /dev/null +++ b/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. From f34ed887ff227153dfbda6ed2b9912670ca5f166 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Fri, 18 Oct 2024 07:47:11 +0100 Subject: [PATCH 23/28] Write docs for `src/Files.App/Strings` Does it look a bit too familiar? --- src/Files.App/Strings/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 src/Files.App/Strings/README.md diff --git a/src/Files.App/Strings/README.md b/src/Files.App/Strings/README.md new file mode 100644 index 000000000000..3d3097e0d94a --- /dev/null +++ b/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). From 8d985d22edfd77f5c87bd7833f012f24b9d82cf6 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Fri, 18 Oct 2024 07:50:44 +0100 Subject: [PATCH 24/28] Write docs for `src/Files.App/Services` --- src/Files.App/Services/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 src/Files.App/Services/README.md diff --git a/src/Files.App/Services/README.md b/src/Files.App/Services/README.md new file mode 100644 index 000000000000..add6296b963d --- /dev/null +++ b/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. From 66ce9683e97f7392e54a02111bb2c87c3a80cbe6 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Fri, 18 Oct 2024 07:53:46 +0100 Subject: [PATCH 25/28] Write docs for `src/Files.App/Properties` --- src/Files.App/Properties/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App/Properties/README.md diff --git a/src/Files.App/Properties/README.md b/src/Files.App/Properties/README.md new file mode 100644 index 000000000000..df3599e34cf4 --- /dev/null +++ b/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. From 095a26325dd09acfae94c2f0b7491d772e482626 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Fri, 18 Oct 2024 07:54:11 +0100 Subject: [PATCH 26/28] Write docs for `src/Files.App/Properties/PublishProfiles` --- src/Files.App/Properties/PublishProfiles/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App/Properties/PublishProfiles/README.md diff --git a/src/Files.App/Properties/PublishProfiles/README.md b/src/Files.App/Properties/PublishProfiles/README.md new file mode 100644 index 000000000000..85ff22cae482 --- /dev/null +++ b/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. From 244a7e2023ad4cf207a4b6e9ac06486cd4834e6a Mon Sep 17 00:00:00 2001 From: Lamparter Date: Fri, 18 Oct 2024 07:55:40 +0100 Subject: [PATCH 27/28] Write docs for `src/Files.App/Helpers` --- src/Files.App/Helpers/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 src/Files.App/Helpers/README.md diff --git a/src/Files.App/Helpers/README.md b/src/Files.App/Helpers/README.md new file mode 100644 index 000000000000..7758f461543b --- /dev/null +++ b/src/Files.App/Helpers/README.md @@ -0,0 +1,3 @@ +# `src/Files.App/Helpers` + +This folder contains helpers for performing operations across the app. From 62f7a561e1702125c13ea74eac3d667980ecba72 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Fri, 18 Oct 2024 17:37:12 +0100 Subject: [PATCH 28/28] Write docs for `src/Files.App/Extensions` --- src/Files.App/Extensions/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 src/Files.App/Extensions/README.md diff --git a/src/Files.App/Extensions/README.md b/src/Files.App/Extensions/README.md new file mode 100644 index 000000000000..7d49c1bee0cf --- /dev/null +++ b/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(); + } +} +```