Improve readme files.#95
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the project’s public-facing documentation to provide a clearer user guide, streamlined top-level README, and more complete contributor/developer instructions.
Changes:
- Rewrote
src/Client/README.mdinto a structured “Get Started” + “Features” user guide with updated links and requirements. - Refreshed the root
README.mdwith badges, a concise feature list, install steps, and a pointer to the user guide. - Expanded
CONTRIBUTING.mdwith repository structure, debugging, packaging, and manual install/uninstall instructions.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Client/README.md | Reorganized into a clearer end-user guide with steps, feature sections, and updated links/requirements. |
| README.md | Simplified and modernized the main README with badges, feature highlights, install instructions, and a user guide link. |
| CONTRIBUTING.md | Added repository structure and expanded development/debugging/packaging instructions for contributors. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@microsoft-github-policy-service agree company="Microsoft" |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Query Editor (query set documents) | ||
|
|
||
| 1. Select the **Kusto Explorer** icon in the VS Code Activity Bar | ||
| 2. Open a scratch pad or create a `.kql` file |
There was a problem hiding this comment.
The scratch pad will already be open, so a better phrasing is "Use an existing scratch pad (already open) or create a '.kql' file."
|
|
||
| 1. Select the **Kusto Explorer** icon in the VS Code Activity Bar | ||
| 2. Open a scratch pad or create a `.kql` file | ||
| 3. Connect to a Kusto cluster and database: |
There was a problem hiding this comment.
This wording changes the meaning. You are not just connecting to a cluster and database; you are making an association between a document and a cluster/database. This is key, because you must make the connection panel selection while the query document has focus.
| Run `code --uninstall-extension Microsoft.kusto-explorer-vscode` on command line. | ||
| 1. Open the **Kusto Explorer** icon in the VS Code Activity Bar | ||
| 2. Add a cluster connection in the **Connections** sidebar | ||
| 3. Select a database to set it as active for your query document |
There was a problem hiding this comment.
You need to have selected a query document first
mattwar
left a comment
mattwar
left a comment
There was a problem hiding this comment.
Most of these changes are fine, but some have changed meaning, making the instructions incorrect.
Move all internal implementation details to the contrbuting.md file.
Cross links to the marketplace.
general alignment.