Azure / Azure/typespec-azure

Remove readme.md

Open
#4,830 0 comments 0 reactions 0 assignees View on GitHub
eng feature triaged:core
Dominant language
TypeScript
Stars
27
Forks
90
Avg merge
1d 22h
Merged PRs (30d)
156

Description

**Target: January 2027**

Part of #4825.

RFC: https://github.com/Azure/azure-rest-api-specs/blob/rfc/unified-examples-format/documentation/rfc/service-yaml.md

**Remove `readme.md`** from the repo once `service.yaml` is validated (#4828) and contributor docs are updated (#4829). Generate on demand only if a legacy consumer still needs it.

Depends on #4828 and #4829.

Contributor guide

Open the contributing guide

Research direction

Review the repository's readme.md and the linked RFC for the service.yaml migration. Wait for #4828 and #4829 to validate service.yaml and update contributor documentation, then remove readme.md and confirm whether any legacy consumer still requires on-demand generation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.