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.

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

System.Console: Backport MS Docs documentation to triple slash #48959

Closed
carlossanlop opened this issue Mar 2, 2021 · 3 comments
Closed

System.Console: Backport MS Docs documentation to triple slash #48959

carlossanlop opened this issue Mar 2, 2021 · 3 comments
Labels
area-System.Console documentation Documentation bug or enhancement, does not impact product or test code
Milestone

Comments

@carlossanlop
Copy link
Member

We are working on a new documentation process plan, in which the main objective is to make triple slash comments the source of truth for documentation, instead of MS Docs: We want developers/maintainers to have an easier time maintaining the documentation for their APIs.

You can use the DocsPortingTool to automate the backport process: Run the tool targeting the assembly, then submit a PR with the changes.

You can find detailed instructions for the backporting process here.

Area owners are free to decide if they want to address this in 6.0 or in Future.

@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code area-System.Console labels Mar 2, 2021
@carlossanlop carlossanlop added this to the 6.0.0 milestone Mar 2, 2021
@dotnet-issue-labeler dotnet-issue-labeler bot added the untriaged New issue has not been triaged by the area owner label Mar 2, 2021
@ghost
Copy link

ghost commented Mar 2, 2021

Tagging subscribers to this area:
See info in area-owners.md if you want to be subscribed.

Issue Details

We are working on a new documentation process plan, in which the main objective is to make triple slash comments the source of truth for documentation, instead of MS Docs: We want developers/maintainers to have an easier time maintaining the documentation for their APIs.

You can use the DocsPortingTool to automate the backport process: Run the tool targeting the assembly, then submit a PR with the changes.

You can find detailed instructions for the backporting process here.

Area owners are free to decide if they want to address this in 6.0 or in Future.

Author: carlossanlop
Assignees: -
Labels:

area-System.Console, documentation

Milestone: 6.0.0

@carlossanlop carlossanlop removed the untriaged New issue has not been triaged by the area owner label Mar 2, 2021
@carlossanlop
Copy link
Member Author

cc @adamsitnik @jozkee I marked this for 6.0

@jeffhandley
Copy link
Member

We are closing all of the issues for backporting api docs to triple-slash comments for now. We concluded early in the .NET 7.0 release cycle that we need to invest more into the DocsPortingTool to set this effort up for success. When we're able to revisit this, we will open new issues per area again.

@jeffhandley jeffhandley closed this as not planned Won't fix, can't repro, duplicate, stale Jul 8, 2022
@ghost ghost locked as resolved and limited conversation to collaborators Aug 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.Console documentation Documentation bug or enhancement, does not impact product or test code
Projects
None yet
Development

No branches or pull requests

2 participants