Skip to content

Commit 0e2c203

Browse files
committed
Move links to left nav bar, import analyzer rules
1 parent 1004972 commit 0e2c203

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+548
-240
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.site/
2+
_exported_templates/
23
node_modules/
34
bin/
45
obj/

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

site/docfx.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,13 @@
3131
"globalMetadata": {
3232
"_appName": "xUnit.net",
3333
"_appTitle": "xUnit.net",
34-
"_appFooter": "<div class=\"align-right\"><a href=\"https://github.com/xunit/xunit.net\">Contribute to the documentation</a></div>Copyright &copy; <a href=\"https://dotnetfoundation.org/\">.NET Foundation</a>. Made with <a href=\"https://github.com/dotnet/docfx\">DocFX</a>.",
34+
"_appFooter": "Copyright &copy; <a href='https://dotnetfoundation.org/'>.NET Foundation</a>. Site built with <a href='https://github.com/dotnet/docfx'>DocFX</a>. Contributions welcomed at <a href='https://github.com/xunit/xunit.net'>https://github.com/xunit/xunit.net</a>.",
3535
"_appFaviconPath": "images/logo-128-transparent.png",
36+
"_disableBreadcrumb": true,
37+
"_disableNavbar": true,
38+
"_disableNextArticle": true,
3639
"_disableToc": false,
40+
"_enableNewTab": true,
3741
"_enableSearch": true,
3842
"pdf": false
3943
},

site/governance.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
---
2-
layout: default
32
title: Governance
4-
breadcrumb: Governance
53
---
64

75
# Governance

site/index.md

Lines changed: 8 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,14 @@ xUnit.net is a free, open source, community-focused unit testing tool for C#, F#
1010

1111
xUnit.net works with the [.NET SDK](https://dotnet.microsoft.com/download) command line tools, [Visual Studio](https://visualstudio.microsoft.com/), [Visual Studio Code](https://code.visualstudio.com/), [JetBrains Rider](https://www.jetbrains.com/rider/), [NCrunch](https://www.ncrunch.net/), and any development environment compatible with [Microsoft Testing Platform](https://learn.microsoft.com/dotnet/core/testing/microsoft-testing-platform-intro) or [VSTest](https://github.com/microsoft/vstest).
1212

13-
xUnit.net is part of the [.NET Foundation](https://www.dotnetfoundation.org/) and operates under their [code of conduct](https://www.dotnetfoundation.org/code-of-conduct). It is licensed under [Apache 2](https://opensource.org/licenses/Apache-2.0) (an OSI approved license).
13+
xUnit.net is part of the [.NET Foundation](https://www.dotnetfoundation.org/) and operates under their [code of conduct](https://www.dotnetfoundation.org/code-of-conduct). It is licensed under [Apache 2](https://opensource.org/licenses/Apache-2.0) (an OSI approved license). The project is [governed](/governance) by a Project Lead.
1414

1515
{ .about-links }
1616
> Follow: <a href="https://dotnet.social/@xunit" rel="me">xUnit.net on Mastodon</a>, [xUnit.net on BlueSky](https://bsky.app/@xunit.net), [Brad Wilson](https://bradwilson.dev/), [James Newkirk](https://www.jamesnewkirk.com/), [Claire Novotny](https://github.com/clairernovotny)<br />
1717
> JetBrains Rider support is provided and supported by [JetBrains](https://www.jetbrains.com/).<br />
1818
> NCrunch support is provided and supported by [Remco Software](https://www.ncrunch.net/).<br />
1919
> The xUnit.net logo was designed by [Nathan Young](https://mas.to/@nathanyoung).
2020
21-
22-
- [Quick Start with .NET SDK](#quick-start-with-net-sdk)
23-
- [Documentation](#documentation)
24-
- [Issues and Discussions](#issues-and-discussions)
25-
- [Release Notes](#release-notes)
26-
- [Latest Builds](#latest-builds)
27-
2821
## Quick Start with .NET SDK
2922

3023
### [C#](#tab/cs)
@@ -257,74 +250,12 @@ xUnit.net v3 In-Process Runner v2.0.3+216a74a292 (64-bit .NET 8.0.17)
257250

258251
---
259252

260-
## Documentation
261-
262-
### Getting Started
263-
264-
* [Getting started with the .NET SDK command line](/docs/v3/getting-started)<br />
265-
_Includes running tests from the command line, Visual Studio, Visual Studio Code, and JetBrains Rider_
266-
* [API documentation](https://api.xunit.net/)
267-
* [xUnit.net analyzer documentation](/xunit.analyzers/rules/)
268-
* [Query filter language](/docs/v3/query-filter-language)
269-
* [NuGet packages](/docs/v3/nuget-packages)
270-
* [Configuration with `xunit.runner.json`](/docs/configuration-files)
271-
* [Sample projects (including testing and extensibility)](https://github.com/xunit/samples.xunit)
272-
273-
### Migrating from xUnit.net v2
274-
275-
* [What's new in xUnit.net v3?](/docs/v3/whats-new)
276-
* Migrating from xUnit.net v2 [for unit test authors](/docs/v3/migration) and [extensibility authors](/docs/v3/migration-extensibility)
277-
278-
### Unit Test Parallelism
279-
280-
* [Running tests in parallel](/docs/running-tests-in-parallel)
281-
* [Sharing context between tests](/docs/shared-context) (class, collection, and assembly fixtures)
282-
283-
### Microsoft Testing Platform
284-
285-
* [Microsoft Testing Platform support](/docs/v3/microsoft-testing-platform)
286-
* [Code Coverage with Microsoft Testing Platform](/docs/v3/code-coverage-with-mtp)
287-
* [Configuration with `testconfig.json` with Microsoft Testing Platform](/docs/v3/testconfig-json)
288-
289-
### VSTest and `xunit.runner.visualstudio`
290-
291-
* [Configuration with RunSettings](/docs/runsettings)
292-
293-
### Test Results in CI Systems
294-
295-
* [Getting Test Results in Azure DevOps](/docs/getting-test-results-in-azure-devops)
296-
* [Getting Test Results in TeamCity](/docs/getting-test-results-in-teamcity)
297-
* [Getting Test Results in CruiseControl.NET](/docs/getting-test-results-in-ccnet)
298-
299-
### Frequently Asked Questions
300-
301-
* [How do I use a CI build NuGet package?](/docs/using-ci-builds)
302-
* [What is the JSON schema for `xunit.runner.json`?](/schema/)
303-
* [What is the format of the XML generated by the test runners?](/docs/format-xml-v2)
304-
* [How do I build xUnit.net?](https://github.com/xunit/xunit/blob/main/BUILDING.md)
305-
* [Why doesn't xUnit.net support netstandard?](/docs/why-no-netstandard)
306-
* [What is "theory data stability"?](/docs/theory-data-stability-in-vs)
307-
308-
### Advanced topics
309-
310-
* [Capturing output](/docs/capturing-output)
311-
* [Serialization with `IXunitSerializer` and `IXunitSerializable`](/docs/custom-serialization)
312-
* [Writing a custom Runner Reporter](/docs/custom-runner-reporter)
313-
* [Multi-targeting on non-Windows OSes](/docs/getting-started/multi-target/non-windows)
314-
* [Equality with hash sets vs. linear containers](/docs/hash-sets-vs-linear-containers)
315-
316-
## Issues and Discussions
317-
318-
* Issues in the core framework and analyzers should be reported in the [primary issue tracker](https://github.com/xunit/xunit/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
319-
* Issues in `xunit.runner.visualstudio` should be reported in the [project issue tracker](https://github.com/xunit/visualstudio.xunit/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
320-
* Discussions are hosted in the [primary discussion forums](https://github.com/xunit/xunit/discussions?discussions_q=is%3Aunanswered+is%3Aopen)
321-
322253
## Release Notes
323254

324255
{: .latest }
325256
| | Stable | Prerelease |
326257
| ------------------------- | -------------------------------------------------- | ---------------------------------------------------------------- | -------------------------------
327-
| xunit.v3 | [2.0.3](/releases/v3/2.0.3){: .release } | [3.0.0-pre.25](/releases/v3/3.0.0-pre.25){: .prerelease } | ([all releases](/releases/v3/))
258+
| xunit.v3 | [2.0.3](/releases/2.0.3){: .release } | [3.0.0-pre.25](/releases/3.0.0-pre.25){: .prerelease } | ([all releases](/releases/))
328259
| xunit.analyzers | [1.22.0](/releases/analyzers/1.22.0){: .release } | [1.23.0-pre.3](/releases/analyzers/1.23.0-pre.3){: .prerelease } | ([all releases](/releases/analyzers/))
329260
| xunit.runner.visualstudio | [3.1.1](/releases/visualstudio/3.1.1){: .release } | | ([all releases](/releases/visualstudio/))
330261

@@ -336,3 +267,9 @@ xUnit.net v3 In-Process Runner v2.0.3+216a74a292 (64-bit .NET 8.0.17)
336267
| xunit.v3 | [![](https://img.shields.io/nuget/v/xunit.v3.svg?logo=nuget)](https://www.nuget.org/packages/xunit.v3) | [![](https://img.shields.io/badge/endpoint.svg?url=https://f.feedz.io/xunit/xunit/shield/xunit.v3/latest&color=f58142)](https://feedz.io/org/xunit/repository/xunit/packages/xunit.v3) | [![](https://img.shields.io/endpoint.svg?url=https://actions-badge.atrox.dev/xunit/xunit/badge%3Fref%3Dmain&amp;label=build)](https://actions-badge.atrox.dev/xunit/xunit/goto?ref=main)
337268
| xunit.analyzers | [![](https://img.shields.io/nuget/v/xunit.analyzers.svg?logo=nuget)](https://www.nuget.org/packages/xunit.analyzers) | [![](https://img.shields.io/badge/endpoint.svg?url=https://f.feedz.io/xunit/xunit/shield/xunit.analyzers/latest&color=f58142)](https://feedz.io/org/xunit/repository/xunit/packages/xunit.analyzers) | [![](https://img.shields.io/endpoint.svg?url=https://actions-badge.atrox.dev/xunit/xunit.analyzers/badge%3Fref%3Dmain&amp;label=build)](https://actions-badge.atrox.dev/xunit/xunit.analyzers/goto?ref=main)
338269
| xunit.runner.visualstudio | [![](https://img.shields.io/nuget/v/xunit.runner.visualstudio.svg?logo=nuget)](https://www.nuget.org/packages/xunit.runner.visualstudio) | [![](https://img.shields.io/badge/endpoint.svg?url=https://f.feedz.io/xunit/xunit/shield/xunit.runner.visualstudio/latest&color=f58142)](https://feedz.io/org/xunit/repository/xunit/packages/xunit.runner.visualstudio) | [![](https://img.shields.io/endpoint.svg?url=https://actions-badge.atrox.dev/xunit/visualstudio.xunit/badge%3Fref%3Dmain&amp;label=build)](https://actions-badge.atrox.dev/xunit/visualstudio.xunit/goto?ref=main)
270+
271+
## Issues and Discussions
272+
273+
* Issues in the core framework and analyzers should be reported in the [primary issue tracker](https://github.com/xunit/xunit/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
274+
* Issues in `xunit.runner.visualstudio` should be reported in the [project issue tracker](https://github.com/xunit/visualstudio.xunit/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
275+
* Discussions are hosted in the [primary discussion forums](https://github.com/xunit/xunit/discussions?discussions_q=is%3Aunanswered+is%3Aopen)
Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2+
{{!include(/^public/.*/)}}
3+
{{!include(favicon.ico)}}
4+
{{!include(logo.svg)}}
5+
<!DOCTYPE html>
6+
<html {{#_lang}}lang="{{_lang}}"{{/_lang}}>
7+
<head>
8+
<meta charset="utf-8">
9+
{{#redirect_url}}
10+
<meta http-equiv="refresh" content="0;URL='{{redirect_url}}'">
11+
{{/redirect_url}}
12+
{{^redirect_url}}
13+
<title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
14+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
15+
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
16+
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
17+
{{#description}}<meta name="description" content="{{description}}">{{/description}}
18+
<link rel="icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
19+
<link rel="stylesheet" href="{{_rel}}public/docfx.min.css">
20+
<link rel="stylesheet" href="{{_rel}}public/main.css">
21+
<meta name="docfx:navrel" content="{{_navRel}}">
22+
<meta name="docfx:tocrel" content="{{_tocRel}}">
23+
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
24+
{{#_enableSearch}}<meta name="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
25+
{{#_disableNewTab}}<meta name="docfx:disablenewtab" content="true">{{/_disableNewTab}}
26+
{{#_disableTocFilter}}<meta name="docfx:disabletocfilter" content="true">{{/_disableTocFilter}}
27+
{{#docurl}}<meta name="docfx:docurl" content="{{docurl}}">{{/docurl}}
28+
<meta name="loc:inThisArticle" content="{{__global.inThisArticle}}">
29+
<meta name="loc:searchResultsCount" content="{{__global.searchResultsCount}}">
30+
<meta name="loc:searchNoResults" content="{{__global.searchNoResults}}">
31+
<meta name="loc:tocFilter" content="{{__global.tocFilter}}">
32+
<meta name="loc:nextArticle" content="{{__global.nextArticle}}">
33+
<meta name="loc:prevArticle" content="{{__global.prevArticle}}">
34+
<meta name="loc:themeLight" content="{{__global.themeLight}}">
35+
<meta name="loc:themeDark" content="{{__global.themeDark}}">
36+
<meta name="loc:themeAuto" content="{{__global.themeAuto}}">
37+
<meta name="loc:changeTheme" content="{{__global.changeTheme}}">
38+
<meta name="loc:copy" content="{{__global.copy}}">
39+
<meta name="loc:downloadPdf" content="{{__global.downloadPdf}}">
40+
41+
<script type="module" src="./{{_rel}}public/docfx.min.js"></script>
42+
43+
<script>
44+
const theme = localStorage.getItem('theme') || 'auto'
45+
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
46+
</script>
47+
48+
{{#_googleAnalyticsTagId}}
49+
<script async src="https://www.googletagmanager.com/gtag/js?id={{_googleAnalyticsTagId}}"></script>
50+
<script>
51+
window.dataLayer = window.dataLayer || [];
52+
function gtag() { dataLayer.push(arguments); }
53+
gtag('js', new Date());
54+
gtag('config', '{{_googleAnalyticsTagId}}');
55+
</script>
56+
{{/_googleAnalyticsTagId}}
57+
{{/redirect_url}}
58+
</head>
59+
60+
{{^redirect_url}}
61+
<body class="tex2jax_ignore" data-layout="{{_layout}}{{layout}}" data-yaml-mime="{{yamlmime}}">
62+
<header class="bg-body border-bottom">
63+
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
64+
<div class="container-xxl flex-nowrap">
65+
<a class="navbar-brand" href="{{_appLogoUrl}}{{^_appLogoUrl}}{{_rel}}index.html{{/_appLogoUrl}}">
66+
<img id="logo" class="svg" src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}logo.svg{{/_appLogoPath}}" alt="{{_appName}}" >
67+
{{_appName}}
68+
</a>
69+
<form class="search" role="search" id="search">
70+
<input class="form-control" id="search-query" type="search" disabled placeholder="{{__global.search}}" autocomplete="off" aria-label="Search">
71+
</form>
72+
</div>
73+
</nav>
74+
</header>
75+
76+
<main class="container-xxl">
77+
{{^_disableToc}}
78+
<div class="toc-offcanvas">
79+
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
80+
<div class="offcanvas-header">
81+
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
82+
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
83+
</div>
84+
<div class="offcanvas-body">
85+
<nav class="toc" id="toc"></nav>
86+
</div>
87+
</div>
88+
</div>
89+
{{/_disableToc}}
90+
91+
<div class="content">
92+
<div class="actionbar">
93+
{{^_disableToc}}
94+
<button class="btn btn-lg border-0 d-md-none"
95+
type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas"
96+
aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
97+
<i class="bi bi-list"></i>
98+
</button>
99+
{{/_disableToc}}
100+
101+
{{^_disableBreadcrumb}}
102+
<nav id="breadcrumb"></nav>
103+
{{/_disableBreadcrumb}}
104+
</div>
105+
106+
<article data-uid="{{uid}}">
107+
{{#analyzer}}
108+
<div>
109+
<div style="font-size: 150%; float: right;">
110+
&nbsp;
111+
<span class="label label-version-{{ v2 }}">v2</span>
112+
<span class="label label-version-{{ v3 }}">v3</span>
113+
&nbsp;
114+
<span class="label label-{{ severity }}">{{ severity }}</span>
115+
</div>
116+
<h1>{{ title }}</h1>
117+
</div>
118+
119+
<p><em>&quot;{{description}}&quot;</em><p>
120+
{{/analyzer}}
121+
122+
{{!body}}
123+
</article>
124+
125+
{{^_disableContribution}}
126+
<div class="contribution d-print-none">
127+
{{#sourceurl}}
128+
<a href="{{sourceurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
129+
{{/sourceurl}}
130+
{{^sourceurl}}{{#docurl}}
131+
<a href="{{docurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
132+
{{/docurl}}{{/sourceurl}}
133+
</div>
134+
{{/_disableContribution}}
135+
136+
{{^_disableNextArticle}}
137+
<div class="next-article d-print-none border-top" id="nextArticle"></div>
138+
{{/_disableNextArticle}}
139+
140+
</div>
141+
142+
{{^_disableAffix}}
143+
<div class="affix">
144+
<nav id="affix"></nav>
145+
</div>
146+
{{/_disableAffix}}
147+
</main>
148+
149+
{{#_enableSearch}}
150+
<div class="container-xxl search-results" id="search-results"></div>
151+
{{/_enableSearch}}
152+
153+
<footer class="border-top text-secondary">
154+
<div class="container-xxl">
155+
<div class="flex-fill">
156+
{{{_appFooter}}}{{^_appFooter}}<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>{{/_appFooter}}
157+
</div>
158+
</div>
159+
</footer>
160+
</body>
161+
{{/redirect_url}}
162+
</html>

0 commit comments

Comments
 (0)