Azure / Azure/azure-sdk-tools

[readme generation] Generate readmes with code snippets, or appropriate snippet tags

Open
#11,761 0 comments 0 reactions 0 assignees View on GitHub
AzSDK Tools Agent needs-triage
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 2h
Merged PRs (30d)
130

Description

Each language has a unique way of including snippets in their readmes. For most of these we just need to insert an appropriate slug, based on an example they already have.

This one has some tie-in to the samples generator since samples and snippets (in some languages) overlap, so we'll want to do this _after_ we figure out how that works.

Contributor guide

Open the contributing guide

Research direction

Start by understanding how the samples generator works and review the existing language-specific README examples that use snippets or snippet tags. After the samples/snippets overlap is resolved, done means generated READMEs include the appropriate code snippets or tags for each language.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.