Azure / Azure/azure-sdk-tools

[Docs] Document compat packages

Open
#13,273 0 comments 0 reactions 0 assignees View on GitHub
needs-triage
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

Some packages (like C++ azure-storage-common) have a `Type` of `compat` (as opposed to mgmt or client). Should these packages be documented? If so, where should they be placed in the ToC?

Today, such packages will end up under **Uncategorized Packages**

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are named. Start by locating the package-type classification and ToC generation used for packages such as C++ azure-storage-common; determine whether compat packages should be documented and where they belong. Done means the policy and resulting ToC placement are agreed and documented, rather than leaving them under Uncategorized Packages.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.