Azure / Azure/azure-sdk-tools

Improve documentation in CI fix guide

Open
#12,106 0 comments 0 reactions 0 assignees View on GitHub
Spec PR Tools
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 2h
Merged PRs (30d)
130

Description

With all the move from descend of the alps and updating the WIKI, CI Fix needs to be updated too.
As an example, currently our users are doing too many clicks:

`PR template -> CI Fix Guide -> TypeSpec Validation`

Contributor guide

Open the contributing guide

Research direction

Start by locating the CI Fix guide and the related WIKI content, then compare the path from the PR template to TypeSpec Validation. Identify where the extra navigation steps are documented and update the guide so users can reach TypeSpec Validation with fewer clicks.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.