docs: improve README.md#950
Conversation
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
There was a problem hiding this comment.
Pull Request Overview
This PR improves the project documentation by adding and refining README files and expanding details about tag updates in the targets documentation.
- Added explanations and a mermaid diagram in docs/Targets.md to clarify tag re-assignment behavior.
- Introduced a new docs/README.md with a reorganized documentation structure and enhanced links.
- Updated the main README.md to reference the latest documentation and migration guidance.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/Targets.md | Added explanation and mermaid diagram for tag updates. |
| docs/README.md | Created new README for the docs directory with guided introductions and links. |
| README.md | Updated project documentation, layout, and references. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #950 +/- ##
=======================================
Coverage 81.69% 81.69%
=======================================
Files 64 64
Lines 6119 6119
=======================================
Hits 4999 4999
Misses 790 790
Partials 330 330 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the project documentation by adding a docs-specific README file, refining the main README, and clarifying tag associations in the Targets file.
- Introduces a new docs/README.md with structured documentation links.
- Updates the main README.md to improve clarity on versioning, community guidelines, and usage.
- Adds an explanation with a mermaid diagram in docs/Targets.md to illustrate tag reassignments.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/Targets.md | Added an explanation and diagram to clarify tag update behavior. |
| docs/README.md | Introduced a new README for the docs directory. |
| README.md | Revised introduction, versioning, and community sections. |
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
There was a problem hiding this comment.
Pull Request Overview
This pull request improves documentation by adding a new README file in the docs directory, updating the project README, and enhancing the explanation regarding tag updates in the targets diagram.
- Added a detailed README for the docs directory with a quickstart and documentation links
- Updated the main project README to improve clarity and navigation
- Enhanced documentation in the targets file with an updated tag association explanation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/Targets.md | Added explanation and diagram for tag re-association behavior |
| docs/README.md | Introduced a new README with an overview of fundamental topics |
| README.md | Refined content, updated links, and clarified migration instructions |
There was a problem hiding this comment.
Pull Request Overview
This PR improves the project documentation by adding a new README file for the docs directory, refining the project README, and including an explanation about tag updates in the targets documentation.
- Introduces docs/README.md with quickstart and fundamentals information
- Revises the main README.md to enhance clarity, organization, and link accuracy
- Updates docs/Targets.md with a detailed explanation and an updated graph example of tag reuse
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/Targets.md | Adds explanation about tag updating and includes a new Mermaid graph |
| docs/README.md | New documentation file outlining fundamentals and quickstart links |
| README.md | Refines overall project documentation, improving introductions and links |
Comments suppressed due to low confidence (1)
docs/Targets.md:125
- The PR description mentions updates in 'docs/Target.md', but the diff shows changes in 'docs/Targets.md'. Please confirm the intended file name to ensure consistency in documentation references.
A descriptor can have multiple tags, but each tag is associated with only one descriptor. Reusing a tag for a different descriptor removes its previous association.
There was a problem hiding this comment.
Pull Request Overview
This PR improves the project's documentation by adding and refining README files and providing a clearer explanation of tag update behavior in the docs. The changes include an enhanced description of how tags are reassigned in docs/Targets.md, a new README.md for the docs directory, and an updated project README.md with improved content structure and metadata.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/Targets.md | Adds an explanation and mermaid diagram for tag update behavior. |
| docs/README.md | Introduces a new documentation file with an overview and tutorial links. |
| README.md | Enhances the existing README with updated badges, versioning, and content reorganization. |
shizhMSFT
left a comment
shizhMSFT
left a comment
There was a problem hiding this comment.
LGTM. The new readme looks prettier.
README.mdfile for thedocsdirectoryREADME.mdfile for the projectdocs/Targets.mdResolve: #813