Skip to content

Commit ab973d2

Browse files
authored
Add table of contents to documentation directory (#26743)
* Add table of contents to documentation repo * Update README.md * Delete PackageArchives.md * Update README.md
1 parent 8220385 commit ab973d2

File tree

2 files changed

+19
-66
lines changed

2 files changed

+19
-66
lines changed

docs/PackageArchives.md

Lines changed: 0 additions & 62 deletions
This file was deleted.

docs/README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,23 @@ Contributor documentation
44
The primary audience for documentation in this folder is contributors to ASP.NET Core.
55
If you are looking for documentation on how to *use* ASP.NET Core, go to <https://docs.asp.net>.
66

7-
# ASP.NET Core developer workflow
7+
> :bulb: If you're a new contributor looking to set up the repo locally, the [build from source documentation](BuildFromSource.md) is the best place to start.
88
9-
- [Building from source](BuildFromSource.md)
10-
- [Troubleshooting build errors](BuildErrors.md)
11-
- [Artifacts structure](Artifacts.md)
9+
The table below outlines the different docs in this folder and what they are helpful for.
10+
11+
| Documentation | What is it about? | Who is it for? |
12+
|--------------------------------------------------------------------------|-------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
13+
| [API review process](APIReviewProcess.md) | Outlines the process for reviewing API changes in ASP.NET Core | Anyone looking to understand the process for making API changes to ASP.NET Core |
14+
| [Artifacts structure](Artifacts.md) | Outlines the artifacts produced by the build | Anyone looking to understand artifiacts produced from an Azure DevOps build |
15+
| [Troubleshooting build errors](BuildErrors.md) | Common errors that occur when building the repo and how to resolve them | Anyone running into an issue with the build |
16+
| [Building from source](BuildFromSource.md) | Setup instructions for the ASP.NET Core repo | First-time contributors |
17+
| [Working with EventSources and EventCounters](EventSourceAndCounters.md) | Guidance on adding event tracing to a library | Anyone needing to add event tracing for diagnostics purposes |
18+
| [Tests on Helix](Helix.md) | An overview of the Helix test environment | Anyone debugging tests in Helix or looking to understand the output from Helix builds |
19+
| [Issue management](IssueManagementPolicies.md) | Overview of policies in place to manage issues| Community members and collaborators looking to understand how we handle closed issue, issues that need author feedback, etc | |
20+
| [Preparing a patch update](PreparingPatchUpdates.md) | Documentation on how to setup for a patch release of ASP.NET Core | Anyone looking to publish servicing updates |
21+
| [Project properties](ProjectProperties.md) | Overview of configurable MSBuild properties on the repo | Anyone looking to modify how a project is packaged |
22+
| [How references are resolved](ReferenceResolution.md) | Overview of dependency reference setup in the repo | Anyone looking to understand how package references are configured in the repo |
23+
| [Servicing changes](Servicing.md) | Documentation on how to submit servicing PRs to previous releases | Anyone to submit patches or backports to prior releases, contains the "Shiproom Template" |
24+
| [Shared framework](SharedFramework.md) | Overview of the ASP.NET Core Shared framework | Anyone looking to understand the policies in place for managing the code of the shared framework |
25+
| Submodules | Documentation on working with submodules in Git | Anyone working with submodules in the repo |
26+
| [Triage process](TriageProcess.md)| Overview of the issue triage process used in the repo | Anyone looking to understand the triage process on the repo |

0 commit comments

Comments
 (0)