Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README to Html.Abstractions and update Components README #27833

Merged
merged 4 commits into from
Nov 20, 2020
Merged

Add README to Html.Abstractions and update Components README #27833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bf4321a
Add README to Html.Abstractions
captainsafia Nov 13, 2020
28259c1
Address feedback from peer review
captainsafia Nov 17, 2020
b07c3a4
Update build instructions for components project
captainsafia Nov 17, 2020
90655a4
Apply suggestions from code review
captainsafia Nov 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/Components/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ The following contains a description of each sub-directory in the `Components` d

### Build

To build this specific project from source, you can follow the instructions [on building a subset of the code](https://github.com/dotnet/aspnetcore/blob/master/docs/BuildFromSource.md#building-a-subset-of-the-code).
To build this specific project from source, follow the instructions [on building a subset of the code](../../BuildFromSource.md#building-a-subset-of-the-code).

**Note:** You also need to run the preceding `build` command in the command line before building in VS to ensure that the Web.JS dependency is built.

### Test

Expand All @@ -46,7 +48,7 @@ The E2E tests are located in the top-level `tests` folder in this directory. The

Each app server mounts the same `BasicTestApp` application under each scenario.

To run the tests for this project, you can [run the tests on the command line](https://github.com/dotnet/aspnetcore/blob/master/docs/BuildFromSource.md#running-tests-on-command-line) in this directory.
To run the tests for this project, [run the tests on the command line](../../BuildFromSource.md#running-tests-on-command-line) in this directory.

## More Information

Expand Down
21 changes: 21 additions & 0 deletions src/Html/Abstractions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Html.Abstractions

This project contains types for manipulating HTML content.

## Description

This project contains interfaces and abstractions used in MVC to support writing and modifying HTML content. For a full list of the types defined in this class, see [the namespace documentation](https://docs.microsoft.com/dotnet/api/microsoft.aspnetcore.html).

## Development Setup

### Build

To build this specific project from source, follow the instructions [on building a subset of the code](../../../BuildFromSource.md#building-a-subset-of-the-code).

### Test

To run the tests for this project, [run the tests on the command line](../../../BuildFromSource.md#running-tests-on-command-line) in this directory.

## More Information

For more information, see the [ASP.NET Core README](../../../README.md).