Skip to content

Commit 02bc21e

Browse files
authored
docs: Product docs rework for new release (#8332)
1 parent 392eefa commit 02bc21e

File tree

125 files changed

+1020
-7003
lines changed

Some content is hidden

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

125 files changed

+1020
-7003
lines changed

.gitignore

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,20 @@
1-
packages
21
bin
3-
csx
42
obj
5-
xdocoutput
3+
drop
4+
temp
65
node_modules
7-
*.sln.ide
8-
TestResults
9-
TestTools
106
.vs
117
.vscode
12-
.NuGet
13-
artifacts
14-
target
158
_site
169
_site_pdf
10+
docs/api
1711

18-
*.nupkg
1912
*.log
20-
*.tmp
21-
*.vsprops
22-
*.suo
23-
*.user
24-
*.userprefs
25-
*.sdf
26-
*.sln.ide
2713
*.cache
28-
*.sln.metaproj
2914
.settings
3015
.DS_Store
31-
log.txt
32-
debugSettings.json
3316
launchSettings.json
34-
project.lock.json
3517
package-lock.json
3618
*.sublime-workspace
3719
*.nuget.targets
20+
*.code-workspace

.vsconfig

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,17 @@
44
"Microsoft.VisualStudio.Component.CoreEditor",
55
"Microsoft.VisualStudio.Workload.CoreEditor",
66
"Microsoft.VisualStudio.Component.NuGet",
7-
"Microsoft.Net.Component.4.6.1.TargetingPack",
87
"Microsoft.VisualStudio.Component.Roslyn.Compiler",
98
"Microsoft.VisualStudio.Component.Roslyn.LanguageServices",
109
"Microsoft.VisualStudio.Component.FSharp",
11-
"Microsoft.Net.Core.Component.SDK.2.1",
12-
"Microsoft.Net.Component.4.7.2.SDK",
13-
"Microsoft.Net.Component.4.7.2.TargetingPack",
10+
"Microsoft.NetCore.Component.SDK",
1411
"Microsoft.Net.ComponentGroup.DevelopmentPrerequisites",
1512
"Microsoft.Component.MSBuild",
16-
"Microsoft.VisualStudio.Component.TextTemplating",
17-
"Microsoft.VisualStudio.Component.SQL.CLR",
1813
"Microsoft.VisualStudio.Component.ManagedDesktop.Core",
19-
"Microsoft.Net.Component.4.5.2.TargetingPack",
20-
"Microsoft.Net.Component.4.5.TargetingPack",
21-
"Microsoft.VisualStudio.Component.IntelliCode",
22-
"Microsoft.Net.Component.4.TargetingPack",
23-
"Microsoft.Net.Component.4.5.1.TargetingPack",
24-
"Microsoft.Net.Component.4.6.TargetingPack",
2514
"Microsoft.Net.ComponentGroup.TargetingPacks.Common",
2615
"Microsoft.VisualStudio.Component.IntelliTrace.FrontEnd",
2716
"Microsoft.VisualStudio.Component.DiagnosticTools",
28-
"Microsoft.VisualStudio.Component.EntityFramework",
29-
"Microsoft.VisualStudio.Component.LiveUnitTesting",
30-
"Component.Microsoft.VisualStudio.LiveShare",
3117
"Microsoft.VisualStudio.Component.ManagedDesktop.Prerequisites",
32-
"Microsoft.ComponentGroup.Blend",
3318
"Microsoft.VisualStudio.Component.Debugger.JustInTime",
3419
"Microsoft.VisualStudio.Workload.ManagedDesktop"
3520
]

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@
1212

1313
Build your technical documentation site with docfx, with landing pages, markdown, API reference docs for .NET, REST API and more.
1414

15-
> ⚠️⚠️⚠️ NOTICE ⚠️⚠️⚠️:
15+
> ⚠️⚠️⚠️ NOTICE ⚠️⚠️⚠️
1616
>
1717
> For [Microsoft Learn](https://learn.microsoft.com/) users, the open source version of docfx [_will NOT_ be maintained to support Microsoft Learn content](https://github.com/dotnet/docfx/discussions/8277#discussioncomment-4409645). For Microsoft Learn feature requests, bug reports and other support ticks, use internal channels such as the [Learn Platform Support Channel](https://teams.microsoft.com/l/team/19%3a7ecffca1166a4a3986fed528cf0870ee%40thread.skype/conversations?groupId=de9ddba4-2574-4830-87ed-41668c07a1ca&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47).
1818
1919
## Getting Started
2020

21-
1. Install docfx using [`choco`](https://chocolatey.org/):
21+
1. Install docfx as a global tool:
2222

2323
```bash
24-
choco install docfx
24+
dotnet tool install -g docfx
2525
```
2626

2727
2. Create and start a website locally:

RELEASENOTE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
Version Notes (Current Version: v2.59.5)
1+
Release Notes
22
=======================================
33

4+
> NOTE: Starting from v2.30.0, release notes are published to [GitHub Releases](https://github.com/dotnet/docfx/releases).
5+
46
v2.59.5
57
-----------
68
1. Fix: TOC word-break not being inserted in generic types. Thanks @julesabr! (#8217)

docs/apispec/YamlUtility.md

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

docs/apispec/overwriteSdp.md

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

docs/codesnippet/Rtf/Hyperlink/RtfDocumentProcessor.cs

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

docs/codesnippet/Rtf/RtfBuildStep.cs

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

docs/codesnippet/Rtf/RtfDocumentProcessor.cs

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

0 commit comments

Comments
 (0)