Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved README.md: Content Restructuring, URL Corrections, and Formatting Enhancements #88

Merged
merged 7 commits into from
Jul 9, 2024

Conversation

skytin1004
Copy link
Contributor

@skytin1004 skytin1004 commented Jul 8, 2024

Purpose

I have improved the README.md in the Phi-3 Cookbook, focusing on content restructuring, URL corrections, typo fixes and formatting improvements for better readability and maintenance.

Changes

  1. Repositioned Guides:

    • Reorganized the list of guides in the Phi-3 Cookbook to improve visibility and accessibility for users.
    • Consolidated the content related to the Phi-3 Family from README.md into 01.Introduce/Phi3Family.md . In README.md, provided a brief mention of the Phi-3 Family with a link to the detailed Markdown file.
  2. URL Corrections:

    • Fixed incorrect URLs that included aka.ms links.
  3. Formatting Enhancements:

    • Modified the "Multi-language Support" section to a tabular format, allowing for future expansions and better organization.
[ ] Yes
[x] No

Does this require changes to learn.microsoft.com docs?

This repository is referenced by (https://azure.microsoft.com/products/phi-3)
which includes deployment, settings and usage instructions.

[ ] Yes
[x] No

Type of change

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[x] Documentation content changes
[ ] Other... Please describe:

Copy link

github-actions bot commented Jul 8, 2024

Check Broken URLs

We have automatically detected the following broken URLs in your files. Review and fix the paths to resolve this issue.

Check the file paths and associated broken URLs inside them. For more details, check our Contributing Guide.

File Full Path Issues
./md/02.QuickStart/AITookit_QuickStart.md 1. https://code.visualstudio.com/docs/setup/additional-components#_vs-code-extensions
2. https://code.visualstudio.com/docs/setup/windows
./md/02.QuickStart/translations/zh-cn/AITookit_QuickStart.md 1. https://code.visualstudio.com/docs/setup/additional-components#_vs-code-extensions
2. https://code.visualstudio.com/docs/setup/windows
./md/02.QuickStart/translations/zh-tw/AITookit_QuickStart.md 1. https://code.visualstudio.com/docs/setup/additional-components#_vs-code-extensions
2. https://code.visualstudio.com/docs/setup/windows
./md/07.Labs/VSCode/README.md 1. https://code.visualstudio.com/docs/copilot/copilot-chat
2. https://code.visualstudio.com/docs/copilot/workspace-context
3. https://code.visualstudio.com/api/extension-guides/chat
./md/07.Labs/VSCode/HOL/AIPC/04.CreatePhi3AgentInVSCode.md 1. https://code.visualstudio.com/api/get-started/your-first-extension
./md/07.Labs/VSCode/HOL/Apple/04.CreatePhi3AgentInVSCode.md 1. https://code.visualstudio.com/api/get-started/your-first-extension
./md/07.Labs/translations/zh-cn/VSCode/README.md 1. https://code.visualstudio.com/docs/copilot/copilot-chat
2. https://code.visualstudio.com/docs/copilot/workspace-context
3. https://code.visualstudio.com/api/extension-guides/chat
./md/07.Labs/translations/zh-cn/VSCode/HOL/AIPC/04.CreatePhi3AgentInVSCode.md 1. https://code.visualstudio.com/api/get-started/your-first-extension
./md/07.Labs/translations/zh-cn/VSCode/HOL/Apple/04.CreatePhi3AgentInVSCode.md 1. https://code.visualstudio.com/api/get-started/your-first-extension
./md/07.Labs/translations/zh-cn/Csharp/csharplabs.md 1. https://code.visualstudio.com/
./md/07.Labs/translations/zh-tw/VSCode/README.md 1. https://code.visualstudio.com/docs/copilot/copilot-chat
2. https://code.visualstudio.com/docs/copilot/workspace-context
3. https://code.visualstudio.com/api/extension-guides/chat
./md/07.Labs/translations/zh-tw/VSCode/HOL/AIPC/04.CreatePhi3AgentInVSCode.md 1. https://code.visualstudio.com/api/get-started/your-first-extension
./md/07.Labs/translations/zh-tw/VSCode/HOL/Apple/04.CreatePhi3AgentInVSCode.md 1. https://code.visualstudio.com/api/get-started/your-first-extension
./md/07.Labs/translations/zh-tw/Csharp/csharplabs.md 1. https://code.visualstudio.com/
./md/07.Labs/Csharp/csharplabs.md 1. https://code.visualstudio.com/

@leestott leestott merged commit 7bcb545 into microsoft:main Jul 9, 2024
4 checks passed
@skytin1004 skytin1004 deleted the doc-improvement branch July 10, 2024 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants