Dev/sajee/clean up#235
Merged
Merged
Conversation
…ve unused Waza configuration
style: enhance styles for better visual hierarchy and responsiveness feat: redesign logo with new gradient and iconography chore: reorganize sections in index.html for better navigation and user experience
Contributor
There was a problem hiding this comment.
Pull request overview
This PR focuses on polishing the repo’s public-facing documentation and normalizing several Cosmos DB best-practice rule writeups so they follow the preferred “Incorrect/Correct” framing, while keeping the compiled AGENTS.md output in sync.
Changes:
- Standardizes multiple rule docs to use clearer Incorrect / Correct section headers and improves rule frontmatter consistency (e.g.,
impactcasing, addsimpactDescriptionwhere needed). - Updates evaluation documentation/configuration to reference Vally (including cache/container naming) instead of Waza.
- Refreshes the GitHub Pages site (HTML/CSS + logo) with a new layout and updated installation/evaluation messaging.
Reviewed changes
Copilot reviewed 19 out of 21 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/cosmosdb-best-practices/rules/throughput-container-vs-database.md | Adds explicit Incorrect/Correct framing for throughput-scope guidance. |
| skills/cosmosdb-best-practices/rules/sdk-serialization-enums.md | Normalizes impact metadata and reframes sections around Incorrect/Correct examples. |
| skills/cosmosdb-best-practices/rules/sdk-newtonsoft-dependency.md | Reframes the rule into Incorrect/Correct sections for clarity. |
| skills/cosmosdb-best-practices/rules/sdk-local-dev-config.md | Reframes the rule into Incorrect/Correct sections for clarity. |
| skills/cosmosdb-best-practices/rules/sdk-java-spring-boot-versions.md | Reframes the rule into Incorrect/Correct sections for clarity. |
| skills/cosmosdb-best-practices/rules/sdk-etag-concurrency.md | Reframes the rule into Incorrect/Correct sections for clarity. |
| skills/cosmosdb-best-practices/rules/sdk-emulator-ssl.md | Adds explicit Incorrect/Correct framing around emulator SSL + gateway guidance. |
| skills/cosmosdb-best-practices/rules/pattern-efficient-ranking.md | Reframes the rule into Incorrect/Correct sections for clarity. |
| skills/cosmosdb-best-practices/rules/index-range-vs-hash.md | Adds Incorrect/Correct framing and adjusts the “modern defaults” positioning. |
| skills/cosmosdb-best-practices/rules/index-lazy-consistent.md | Adds Incorrect/Correct framing around indexing-mode selection guidance. |
| skills/cosmosdb-best-practices/rules/global-consistency.md | Adds Incorrect/Correct framing around consistency selection tradeoffs. |
| skills/cosmosdb-best-practices/AGENTS.md | Regenerates compiled guidance to reflect rule doc updates. |
| routing-eval/README.md | Updates routing-eval docs to refer to Vally-based content eval workflows. |
| routing-eval/layer1-acceptance/README.md | Updates acceptance flow docs/links to Vally config naming. |
| README.md | Updates repo-level evaluation instructions to use Vally CLI commands. |
| CONTRIBUTING.md | Updates contributor testing instructions to use Vally CLI commands. |
| .vally.yaml | Renames cache/container identifiers to Vally equivalents. |
| .gitignore | Updates ignored cache directory to .vally-cache/. |
| docs/styles.css | Refreshes site styling, layout, and component styles. |
| docs/logo.svg | Replaces the site logo SVG. |
| docs/index.html | Updates site structure/content (hero, install/coverage/workflow sections, links). |
Comment on lines
+12
to
+13
| **Incorrect (using dedicated throughput everywhere without considering sharing patterns or cost):** | ||
|
|
|
|
||
| Understand when to use different index types. Range indexes support equality, range, and ORDER BY; Hash indexes are deprecated. | ||
|
|
||
| **Incorrect (manually reasoning about deprecated hash indexes or over-specifying index kinds for standard queries):** |
Comment on lines
10
to
14
| Select the consistency level that matches your application's requirements. Each level has different tradeoffs for latency, availability, and consistency. | ||
|
|
||
| **Incorrect (defaulting to the strongest consistency level for every workload without evaluating latency and availability needs):** | ||
|
|
||
| **Consistency levels (strongest to weakest):** |
| </div> | ||
| <div class="hero-metrics"> | ||
| <article> | ||
| <h2>129</h2> |
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
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.
Description
Type of Change
Checklist
npm run validateand it passednpm run buildto regenerate AGENTS.md (if adding/updating rules){prefix}-{description}.mdtitle,impact,tags)For New Rules
Rule file:
skills/cosmosdb-best-practices/rules/_____.mdCategory:
Impact level:
Why is this rule important?
Agent Testing
Related Issues
Additional Notes