Skip to content

Migrate to inline code docs #3357

@mattleibow

Description

@mattleibow

Description

Can you help migrate my docs from the docs folder into the c# source.

  • There is a guide here: ~/API.Docs.Migration.Guide.md
  • This is the checklist of APIs to migrate: ~/API.Docs.Migration.Checklist.md

Please go through each item on the checklist and migrate.

Setup

Make sure that BEFORE you start, checkout all submodules. Don't try build anything or run any tests. The agents are not set up to do this.

Migration

Just go through the checklist and migrate each type.

There is one important thing. Each type should be migrated and commited separately. We have a team that looks at things by commit and they do not want to have multiple types being done in a single commit.

Migrate all the members in the types.

Rules

  • Migrate one type at a time
  • Migrate all the mebers on the type, even if there are many
  • Commit the changes for each type
  • Do not skip a type or member

Metadata

Metadata

Assignees

Labels

area/DocsIssues relating to documentation, such as API docs or conceptual docs.

Type

No type

Projects

Status

New

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions