dotnet/api-docs-sync

View on GitHub

Tools for porting documentation from intellisense xmls to api-docs, or from api-docs to triple slash comments.

Stars: 14
Forks: 21
Open beginner issues: 0
Indexed issues: 51

Dominant language: C#
License: MIT
Last GitHub push: Sep 21, 2024
Latest indexed: Sep 15, 2026
Contributing guide: No contributing guide
Code of conduct: Code of conduct
Beginner labels: No beginner labels indexed
PR merge metrics: No merged PRs in 30d

Beginner friendly Everything

Open All

51 open issues indexed

When a type is marked `forInternalUseOnly` no docs should be ported Open

Difficulty 3/5 1-2 days Newbie friendliness 42/100

dotnet/api-docs-sync#182 · Opened Oct 6, 2025
PortToDocs interprets [x](y) as a hyperlink Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

dotnet/api-docs-sync#181 · Opened Sep 30, 2025
Para tags are mangled when explicitly declared in remarks in combination with new-lines Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

dotnet/api-docs-sync#180 · 1 comment · Opened Sep 29, 2025
PortToDocs changing many docs which aren't touched by intellisense input Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

dotnet/api-docs-sync#179 · Opened Sep 26, 2025
PortToDocs adding inheritdoc for types which aren't publicly documented Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#178 · 1 comment · Opened Sep 25, 2025
PortToDocs tool adding `seealso` elements which duplicate existing `altmember` elements Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#177 · Opened Sep 24, 2025
PortToDocs tool changing line endings or whitespace and nothing else Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

dotnet/api-docs-sync#176 · Opened Sep 24, 2025
Too many \<para> tags added when importing docs from IntelliSense Open

dotnet/api-docs-sync#175 · 1 assignee · Opened Oct 17, 2024
PortToTripleSlash might not be working with Microsoft.BCL assemblies Open

port-to-tripleslash

Difficulty 4/5 3-5 days Newbie friendliness 25/100

dotnet/api-docs-sync#167 · Opened Aug 24, 2023
PortToDocs fails and exits when encountering a malformed xml Open

port-to-docs

Difficulty 3/5 1-2 days Newbie friendliness 42/100

dotnet/api-docs-sync#166 · Opened Aug 23, 2023
Missing item in dotnet-api-docs removes the existing item in triple slash Open

port-to-tripleslash

Difficulty 3/5 1-2 days Newbie friendliness 42/100

dotnet/api-docs-sync#163 · Opened Apr 19, 2023
Some projects can't be ported immediately after building all runtime Open

port-to-tripleslash

Difficulty 3/5 1-2 days Newbie friendliness 45/100

dotnet/api-docs-sync#162 · Opened Apr 19, 2023
Convert markdown to normal xml Open

port-to-tripleslash

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#158 · 1 comment · Opened Feb 3, 2023
`<para></para>` elements should be in their own line Open

port-to-tripleslash

dotnet/api-docs-sync#157 · 1 assignee · Opened Feb 3, 2023
Simplify Roslyn whitespace handling, use autoformatting Open

port-to-tripleslash

dotnet/api-docs-sync#148 · 1 assignee · Opened Nov 29, 2022
Finding a null followed by a see cref ports them without space Open

port-to-docs

Difficulty 3/5 1-2 days Newbie friendliness 42/100

dotnet/api-docs-sync#133 · Opened Oct 10, 2022
Automatically add boilerplate summary for auto-added parameterless constructors Open

port-to-docs

Difficulty 4/5 3-5 days Newbie friendliness 35/100

dotnet/api-docs-sync#132 · Opened Sep 23, 2022
Implement `-PreserveInheritDocTag false` functionality Open

port-to-docs

Difficulty 3/5 1-2 days Newbie friendliness 45/100

dotnet/api-docs-sync#129 · Opened Sep 9, 2022
Conversion of see crefs to xrefs that contain backtick character is not working Open

port-to-docs

Difficulty 3/5 1-2 days Newbie friendliness 48/100

dotnet/api-docs-sync#125 · Opened Aug 17, 2022
xml lists are not getting converted to markdown lists Open

port-to-docs

Difficulty 4/5 3-5 days Newbie friendliness 35/100

dotnet/api-docs-sync#118 · Opened Jun 3, 2022
`<p></p>` elements in xml should be converted to `<para></para>` Open

port-to-docs

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

dotnet/api-docs-sync#115 · Opened Mar 30, 2022
Add exceptions next to each other Open

port-to-docs

Difficulty 3/5 1-2 days Newbie friendliness 38/100

dotnet/api-docs-sync#114 · Opened Mar 29, 2022
`#ctor` in see crefs needs to be converted to `%23ctor` Open

port-to-docs

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

dotnet/api-docs-sync#113 · Opened Mar 29, 2022
Docs Porting Tool improvement Open

epic

Difficulty 5/5 Over a week Newbie friendliness 20/100

dotnet/api-docs-sync#104 · 2 comments · Opened Oct 20, 2021
Missing mapping with ToDocs command Open

port-to-docs

Difficulty 4/5 3-5 days Newbie friendliness 38/100

dotnet/api-docs-sync#95 · Opened Sep 9, 2021
Type docs applied to all partial classes Open

port-to-tripleslash

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#91 · Opened Sep 7, 2021
File 'Accessibility-version.dll' not found or not a PE file Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#88 · Opened Sep 7, 2021
Don't indent remarks Open

port-to-docs

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#84 · 1 comment · Opened Sep 3, 2021
Preserve xml file encoding to prevent non-ascii chars from disappearing Open

port-to-docs

Difficulty 3/5 1-2 days Newbie friendliness 42/100

dotnet/api-docs-sync#82 · 2 comments · Opened Aug 9, 2021
How to deal with cross assembly crefs Open

port-to-tripleslash

Difficulty 5/5 Over a week Newbie friendliness 25/100

dotnet/api-docs-sync#81 · Opened Aug 8, 2021
Bottleneck reading XML element value Open

port-to-docs

Difficulty 3/5 1-2 days Newbie friendliness 55/100

dotnet/api-docs-sync#80 · Opened Aug 3, 2021
Validate against duplicate or otherwise corrupt content Open

port-to-docs

Difficulty 5/5 Over a week Newbie friendliness 25/100

dotnet/api-docs-sync#79 · Opened Aug 2, 2021
Unit tests fail when running against net6.0 Open

port-to-tripleslash

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#69 · Opened Apr 1, 2021
Some markdown-formatted remarks are ported into triple slash comments with invalid structure Open

port-to-tripleslash

Difficulty 4/5 3-5 days Newbie friendliness 42/100

dotnet/api-docs-sync#68 · Opened Mar 31, 2021
cref values including generic types on method parameters get formatted incorrectly Open

port-to-tripleslash

Difficulty 3/5 1-2 days Newbie friendliness 45/100

dotnet/api-docs-sync#67 · 1 comment · Opened Mar 31, 2021
Pragmas before types and members get dropped when porting docs into triple slash comments Open

port-to-tripleslash

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#65 · 2 comments · Opened Mar 31, 2021
Some constructor DocIDs end with #ctor, the tool must convert them to their full method name Open

port-to-docs

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#64 · 1 comment · Opened Mar 31, 2021
Lists should be rendered with <item> Open

port-to-tripleslash

Difficulty 3/5 1-2 days Newbie friendliness 42/100

dotnet/api-docs-sync#61 · 1 comment · Opened Mar 10, 2021
Multiparagraphs with <param> Open

port-to-tripleslash

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#60 · Opened Mar 10, 2021
Remove space at end of xml elements Open

port-to-tripleslash

Difficulty 2/5 1-3 hours Newbie friendliness 58/100

dotnet/api-docs-sync#59 · Opened Mar 10, 2021
Remove namespace prefix from docid if it can be resolved Open

port-to-tripleslash

dotnet/api-docs-sync#58 · 1 assignee · Opened Mar 10, 2021
Lines containing <param> items do not get new lines properly added Open

port-to-tripleslash

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#56 · 1 reaction · Opened Mar 5, 2021
For types that live in a difference assembly than the one that ships it, make sure the MSBuild task will move them to the appropriate intellisense xml Open

port-to-tripleslash

Difficulty 4/5 3-5 days Newbie friendliness 35/100

dotnet/api-docs-sync#54 · Opened Mar 5, 2021
MSBuild task to compare generated xmls Open

Difficulty 5/5 Over a week Newbie friendliness 20/100

dotnet/api-docs-sync#53 · Opened Mar 5, 2021
Error messages when prerequisite is not built Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#51 · Opened Mar 5, 2021
Consider word wrapping triple slash comments Open

port-to-tripleslash

dotnet/api-docs-sync#44 · 1 comment · 1 reaction · 1 assignee · Opened Mar 4, 2021
Tool fails to run with System.InvalidOperationException: Open

dotnet/api-docs-sync#38 · 7 comments · 1 assignee · Opened Mar 4, 2021
Red message saying [Not saved] if user forgot to add -Save true Open

Difficulty 3/5 1-2 days Newbie friendliness 15/100

dotnet/api-docs-sync#16 · Opened Sep 2, 2020
Detect attribute decorators like Obsolete Open

Difficulty 4/5 3-5 days Newbie friendliness 25/100

dotnet/api-docs-sync#14 · Opened Mar 31, 2020
Add option to force update all comments Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

dotnet/api-docs-sync#6 · 1 reaction · Opened Aug 9, 2019

dotnet/api-docs-sync

Get new issues in your inbox