Skip to content

Commit

Permalink
Update docs for our upcoming release (#1492)
Browse files Browse the repository at this point in the history
  • Loading branch information
cinnamon-msft authored Sep 11, 2023
1 parent f9b64a6 commit ad7d68e
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 15 deletions.
12 changes: 6 additions & 6 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Dev Home has a modular architecture that consists of multiple components. These

Dev Home Core is the central part of Dev Home where all the components come together. The functions it performs include:

- Defining the application packaging details
- Running the main application logic including managing lifecycle, managing activations, and creating the main window
- Defining the packaging details
- Running the main logic including managing lifecycle, managing activations, and creating the main window
- Creating UI for the shell page and allowing navigation among tools
- Finding all the available tools and allowing them to be displayed
- Starting and managing the lifecycle of extensions
Expand All @@ -24,15 +24,15 @@ Dev Home Core is the central part of Dev Home where all the components come toge

The Dev Home Common component contains code that is shared among the tools, core, and settings component. It also imports libraries that are used across Dev Home. One such library is the **Dev Home Extension SDK** used to get references to out-of-process extensions.

Dev Home Common also provides logging and telemetry functionality to the application.
Dev Home Common also provides logging and telemetry functionality.

## Settings

This is a special component that acts similarly a tool but isn't actually a tool. The Settings component, like other tools, consumes the Common project and is used by Dev Home Core. It manages user preferences across all tools and extensions.

## Tools

The tools are a set of functionalities that are integrated within the app's codebase. They are designed to provide specific capabilities or features to the app. They live as their own component but run in the same process as the app and can communicate with each other and the core component through the app's API.
The tools are a set of functionalities that are integrated within Dev Home's codebase. They are designed to provide specific capabilities or features to Dev Home. They live as their own component but run in the same process as Dev Home and can communicate with each other and the core component through Dev Home's API.

These tools can use the APIs in the extension SDK to get data or functionality from the extensions.

Expand All @@ -45,8 +45,8 @@ Dev Home currently has the following tools:

## Extensions

Extensions are separate packages living as out-of-process components that provide functionality and data used by the Core component and the tools. These extensions live outside of the app's core codebase, and they interact with the app through a well-defined API or protocol.
Extensions are separate packages living as out-of-process components that provide functionality and data used by the Core component and the tools. These extensions live outside of Dev Home's core codebase and they interact with Dev Home through a well-defined API or protocol.

Extensions can be developed by third-party developers or by the app's core development team. These extensions allow the app to be extended without modifying its core codebase.
Extensions can be developed by third-party developers or by Dev Home's core development team. These extensions allow Dev Home to be extended without modifying its core codebase.

Learn more about [writing an extension](./extensions.md).
2 changes: 1 addition & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Alternatively

### Dev Home framework

The Dev Home project contains the wrapping framework for the Dev Home application.
The Dev Home project contains the wrapping framework for Dev Home.
It's responsible for:
- Loading the individual Dev Home tools.
- Loading out-of-process extensions.
Expand Down
14 changes: 9 additions & 5 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In some cases, we have strategic work taking priority. This includes architectur
The next set of work items to be prioritized are based on "impact". These are items that would substantially improve capabilities.

- App needs notification section in settings https://github.com/microsoft/devhome/issues/503
- Cannot rearrange widgets on dashboard https://github.com/microsoft/devhome/issues/673
- Cannot rearrange widgets on dashboard https://github.com/microsoft/devhome/issues/673
- Detect DSC Configuration file in repo use that as base for setup https://github.com/microsoft/devhome/issues/675
- Marketplace & Library for extensions https://github.com/microsoft/devhome/issues/676
- File Explorer + native Git integration https://github.com/microsoft/devhome/issues/679
Expand All @@ -36,11 +36,11 @@ Dev Home is engineered and delivered as a set of 4-week [milestones]. Below is t
| ------------------ | -------------- | --------- |
| 2023-05-23 | 0.1 | [Introducing Dev Home] |
| 2023-06-15 | [0.2] | [Dev Home Preview 0.2 Release] |
| 2023-07-13 | [0.3] | |
| 2023-08-17 | [0.4] | |
| 2023-07-13 | [0.3] | [Dev Home Preview 0.3 Release] |
| 2023-08-17 | [0.4] | [Dev Home Preview 0.4 Release] |
| 2023-09-14 | [0.5] | |
| 2023-10-12 | 0.6 | |
| 2023-11-16 | 0.7 | |
| 2023-10-12 | [0.6] | |
| 2023-11-16 | [0.7] | |
| 2023-12-14 | 0.8 | |
| 2024-01-18 | 0.9 | |
| 2024-02-15 | 0.10 | |
Expand All @@ -54,6 +54,10 @@ Dev Home is engineered and delivered as a set of 4-week [milestones]. Below is t
[0.3]: https://github.com/microsoft/devhome/milestone/2
[0.4]: https://github.com/microsoft/devhome/milestone/3
[0.5]: https://github.com/microsoft/devhome/milestone/5
[0.6]: https://github.com/microsoft/devhome/milestone/9
[0.7]: https://github.com/microsoft/devhome/milestone/10

[Introducing Dev Home]: https://blogs.windows.com/windowsdeveloper/2023/05/30/introducing-dev-home/
[Dev Home Preview 0.2 Release]: https://blogs.windows.com/windowsdeveloper/2023/06/21/dev-home-preview-0-2-release/
[Dev Home Preview 0.3 Release]: https://blogs.windows.com/windowsdeveloper/2023/07/19/dev-home-preview-0-3-release/
[Dev Home Preview 0.4 Release]: https://blogs.windows.com/windowsdeveloper/2023/08/16/dev-home-preview-0-4-release/
2 changes: 1 addition & 1 deletion docs/tools.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tools

Dev Home adds functionality through a set of tools. Each tool provides a page in the Dev Home navigation view. Currently, all tools come from in-app assemblies. Third party or out-of-process tools are not supported at this time.
Dev Home adds functionality through a set of tools. Each tool provides a page in the Dev Home navigation view. Currently, all tools come from in-package assemblies. Third party or out-of-process tools are not supported at this time.

Tools utilize data and functionality from out-of-process [extensions](./extensions.md). This is done through the Extension SDK API.

Expand Down
2 changes: 1 addition & 1 deletion test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Testing UI Controls

Unit tests that exercise UI controls must run on the WinUI UI thread or they will throw an exception. To run a test on the WinUI UI thread, mark the test method with `[UITestMethod]` instead of `[TestMethod]`. During test execution, the test host will launch the app and dispatch the test to the app's UI thread.
Unit tests that exercise UI controls must run on the WinUI UI thread or they will throw an exception. To run a test on the WinUI UI thread, mark the test method with `[UITestMethod]` instead of `[TestMethod]`. During test execution, the test host will launch Dev Home and dispatch the test to Dev Home's UI thread.

The below example creates a `new Grid()` and then validates that its `ActualWidth` is `0`.

Expand Down
2 changes: 1 addition & 1 deletion uitest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
```
5. From Visual Studio, navigate to the "Test Explorer" tab and locate the `DevHome.UITest` set of tests.
6. Select a test and run it.
- Note: Once the test starts, avoid interacting with your machine (e.g. move mouse, use keyboard) to allow the test to navigate the Dev Home app and execute the test.
- Note: Once the test starts, avoid interacting with your machine (e.g. move mouse, use keyboard) to allow the test to navigate Dev Home and execute the test.

### Run tests on a different release of Dev Home (Canary, Prod, Dev)
#### Option 1: Manually update the Test.runsettings file
Expand Down

0 comments on commit ad7d68e

Please sign in to comment.