Skip to content

7.x to 8.x reference/concept documentation #491

Open
@Arlodotexe

Description

@Arlodotexe

What we're doing

For concept/wiki-like docs, we need to close off this old repo by redirecting its contents to the new repo.

If we have a list or set of guidance for general mapping, we can open up a doc request for the doc team to help us with this.

Why we're doing it

There is no published reference documentation for any Community Toolkit beyond 7.1, and there should be.

Our processes have changed, new major versions were released, new toolkits were created, and our reference docs are neither well-updated nor well-consolidated.

Further, the sample/concept/wiki-like docs for 7x do not redirect to the latest in 8x, and they should.

What we know

A full evaluation and grouping of the concept docs in the old repo are needed to move them to the new repo, including:

  • A list of all Community Toolkit variants, packages and package versions being migrated.
  • Which packages/namespaces/types need to be mapped to 8x+ code.
  • Which packages/namespaces/types need to be redirected due to deprecation.

The Windows Community Toolkit will have reference docs since 8.x generated automatically per-major and per-minor version. We simply need to supply a list of packages (grouped by version) which need to be published on MSLearn.

Docs Publish state Location Needs
7x 8x 7x 8x 7x 8x
Samples / concept Published Published Link Link Map to 8x -> Map from 7x
Reference Published Unpublished Link n/a Map to? Generate. Docs team can do this, but needs package list.

What we need to know

These are also being requested and will need details:

  • The schema of the existing reference doc maps is ambiguous.
    • Will these be generated by the docs team from the nuget packages?
  • The intended placement and grouping of reference documentation per-version in the new repository is ambiguous, as it contains only wiki-like sample documentation.
    • Where will the generated reference documentation be stored? In the current concept/sample doc repo, or somewhere else?
  • Release cycle of the MAUI Community Toolkit is unknown
  • Release cycle of the Aspire Community Toolkit is unknown
  • Release cycle of the Datasync Community Toolkit is unknown

Overall, this task is missing a significant number of high-level details around what needs changed and the approach.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationexternal ⤴️Requires an update to an external dependency or due to code outside the Toolkit.

Type

No type

Projects

Status

🏗 In progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions