Consolidate documentation into docs/ hub#48730
Draft
g2vinay wants to merge 1 commit intoAzure:mainfrom
Draft
Conversation
- Create docs/ as the canonical documentation hub for agents and LLMs - Add docs/contributor/ with 13 files covering setup, building, testing, code quality, versioning, deprecation, release, AutoRest, TypeSpec, Javadoc, performance tests, adding modules, and access helpers - Add docs/user/ with 11 files covering FAQ, identity, configuration, performance tuning, serialization, protocol methods, management libs, test proxy migration, azure-json migration, and Azure v2 guidance - Add docs/README.md (master index) and docs/STRUCTURE.md (placement rules) - Update CONTRIBUTING.md: fix JDK version range, replace bare wiki links with in-repo doc links - Update README.md: add docs/ hub link, remove stale 2019-2020 release links - Update doc/README.md: point to docs/ as canonical hub - Update eng/README.md: add link to docs/ developer guides - Update sdk/storage/CONTRIBUTING.md: replace wiki links with in-repo links, fix 'Jacoco' -> 'JaCoCo' capitalization All wiki content is preserved with attribution links. Files that belong near their code (per-library READMEs, CHANGELOGs, eng/ CI scripts) are explicitly excluded and documented in docs/STRUCTURE.md.
g2vinay
commented
Apr 8, 2026
| @@ -1,5 +1,23 @@ | |||
| This folder contains some documentations for this repository: | |||
| > **Note**: New documentation should be added to the [`docs/`](../docs/README.md) directory, | |||
Member
Author
There was a problem hiding this comment.
merge docs and doc folder together and update this .md accordingly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Creates a single
docs/directory as the canonical documentation hub for this repository, making it easy for agents, LLMs, and new contributors to find all guidance from one structured location. All existing wiki content is pulled in-repo with attribution links back to the wiki.Changes
docs/README.mddocs/STRUCTURE.mddocs/contributor/(13 files)docs/user/(11 files)Updated: existing files
CONTRIBUTING.md— fixed JDK version range (8/11/17/21); replaced bare wiki links with in-repo doc linksREADME.md— addeddocs/hub link in Contributing section; removed stale 2019–2020 release linksdoc/README.md— redirects todocs/as the canonical hubeng/README.md— added link todocs/developer guidessdk/storage/CONTRIBUTING.md— replaced wiki links with in-repo links; fixedJacoco→JaCoCoWhat stays in place
Per the placement rules in
docs/STRUCTURE.md:README.md/CHANGELOG.md— proximity to code matterseng/CI/CD scripts and pipelines — synced fromazure-sdk-toolsdoc/deprecation_process.md— has stableaka.msshortlinks