Skip to content

System.IO.Compression: Backport MS Docs documentation to triple slash #48962

Closed as not planned

Description

@carlossanlop

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.

Activity

  1. added this to the 6.0.0 milestone on Mar 2, 2021
  2. self-assigned this
    on Mar 2, 2021
  3. ghost added
    untriagedNew issue has not been triaged by the area owner
    on Mar 2, 2021
  4. linked a pull request that will close this issueBackport System.IO.Compression docs #48841on Mar 2, 2021
  5. removed
    untriagedNew issue has not been triaged by the area owner
    on Mar 25, 2021
  6. modified the milestones: 6.0.0, 7.0.0 on Jun 25, 2021
  7. jeffhandley commented on Jul 8, 2022

    @jeffhandley
    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.

  8. ghost locked as resolved and limited conversation to collaborators on Aug 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions