Skip to content

created IDE/Agent support table, deleted quickstart section and move…#106

Open
ymakaruk-pixel wants to merge 8 commits into
mainfrom
CTORNDGAIN-1301-FAQ-terminology-readme
Open

created IDE/Agent support table, deleted quickstart section and move…#106
ymakaruk-pixel wants to merge 8 commits into
mainfrom
CTORNDGAIN-1301-FAQ-terminology-readme

Conversation

@ymakaruk-pixel

Copy link
Copy Markdown
Contributor

No description provided.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 8, 2026
@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Rosetta Triage Review

Summary: This PR improves README.md by replacing the plain comma-separated IDE/Agent list with a structured Plugin/MCP support table, promotes the conflict warning to a GitHub [!WARNING] callout, and repositions the Documentation table to after the Contributions section.

Findings:

  • PR body is empty — no description of what and why the changes were made; the PR title is also truncated (move…), leaving intent unclear.
  • The new IDE/Agent support table clearly shows Plugin vs MCP availability per tool — a meaningful UX improvement for new users choosing an installation path.
  • Removing the "Quick Start" section from near the top reduces discoverability for first-time visitors; consider keeping a minimal entry point or ensuring QUICKSTART.md is still prominently linked in the remaining content.
  • Documentation table moved to after the Contributions section — this is a lower position; users who need docs links will have to scroll past feature descriptions and contribution info.
  • The [!WARNING] callout for conflicting plugins is an improvement over inline plain text.

Suggestions:

  • Add a PR description explaining what was changed and why (link to Jira story CTORNDGAIN-1301 if applicable).
  • Consider whether moving the Documentation table lower reduces its utility — first-time users often look for it early.
  • Verify that removing the Quick Start bullet points does not leave a navigation gap for users who land on the README looking for setup instructions.

Automated triage by Rosetta agent

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

📋 Prompt Quality Validation Report

✅ Validation Passed

Summary by File

File 🔴 Critical 🟠 Very High 🟡 High 🔵 Medium ⚪ Low Status
instructions/r3/core/rules/bootstrap.md 0 0 0 2 1 ⚠️ Warning
instructions/r3/core/rules/local-files-mode.md 0 0 0 2 1 ⚠️ Warning
instructions/r3/core/rules/plugin-files-mode.md 0 0 0 2 1 ⚠️ Warning

📄 instructions/r3/core/rules/bootstrap.md

⚠️ Issues Found

Severity Gate Details
🔵 Medium Conflict Resolution Problem:
Two MUST-USE commands now overlap for the 'add a new phase' case. The new 'plan upsert ... [--kind phase
🔵 Medium Input Contract Problem:
The new positional argument on create-with-template (and "<PHASE_STEPS_JSON_STRING>" in Phase 0 Step 1) has no optional-bracket marker and no in-file format or example, unlike every other optional arg shown as [limit], [--kind ...], or [--target ...]. So it reads as required, but the orchestrator has nothing in the file telling it the JSON shape. This is the mandatory first call of Phase 0.
Reason:
An eager agent that skips 'help plan' may emit malformed JSON on the first required call. Impact is bounded because an omitted value is accepted, but a guessed malformed value still causes an avoidable error and retry.
Solution:
Add a short inline cue to the create-with-template bullet, for example point to 'help plan' for the JSON shape and state a safe fallback of passing an empty array. Mark it optional if it is optional.
⚪ Low Precision & Explicitness Problem:
The same JSON-string argument is quoted inconsistently in Phase 0 prose: create-with-template shows it quoted as "<PHASE_STEPS_JSON_STRING>" while the upsert-with-template delegation line shows it unquoted as . A JSON string with spaces must be shell-quoted.
Reason:
The unquoted exemplar models a call that could break shell argument parsing if copied literally.
Solution:
Quote both occurrences consistently to match the commands-list style.

📊 Gates Comparison

Gate Score Comparison
Input Contract 4 ⬆️ Slightly better
Decision Branching 4 ⬆️ Slightly better
Precision & Explicitness 4 ⬆️ Slightly better
Reference Integrity 5 ⬆️ Slightly better

📄 instructions/r3/core/rules/local-files-mode.md

⚠️ Issues Found

Severity Gate Details
🔵 Medium Conflict Resolution Problem:
Same as bootstrap.md: the new 'plan upsert ... [--kind phase
🔵 Medium Input Contract Problem:
Same as bootstrap.md: the new arg on create-with-template (and "<PHASE_STEPS_JSON_STRING>" in Phase 0 Step 1) has no optional-bracket marker and no in-file format or example, so it reads as required without telling the orchestrator the JSON shape on the mandatory first call.
Reason:
An agent that skips 'help plan' may emit malformed JSON on the first required call; bounded because omission is accepted, but a guessed value still causes an avoidable error and retry.
Solution:
Add a short inline cue pointing to 'help plan' for the JSON shape and state a safe empty-array fallback; mark optional if it is optional.
⚪ Low Precision & Explicitness Problem:
Same as bootstrap.md: the JSON-string arg is quoted as "<PHASE_STEPS_JSON_STRING>" on create-with-template but unquoted as on the upsert-with-template delegation line.
Reason:
The unquoted exemplar models a call that could break shell argument parsing if copied literally.
Solution:
Quote both occurrences consistently to match the commands-list style.

📊 Gates Comparison

Gate Score Comparison
Input Contract 4 ⬆️ Slightly better
Decision Branching 4 ⬆️ Slightly better
Precision & Explicitness 4 ⬆️ Slightly better
Reference Integrity 5 ⬆️ Slightly better
Structural Coherence 5 ⬆️ Slightly better
Bloat Control 5 ⬆️ Slightly better

📄 instructions/r3/core/rules/plugin-files-mode.md

⚠️ Issues Found

Severity Gate Details
🔵 Medium Conflict Resolution Problem:
Same as bootstrap.md: the new 'plan upsert ... [--kind phase
🔵 Medium Input Contract Problem:
Same as bootstrap.md: the new arg on create-with-template (and "<PHASE_STEPS_JSON_STRING>" in Phase 0 Step 1) has no optional-bracket marker and no in-file format or example, so it reads as required without telling the orchestrator the JSON shape on the mandatory first call.
Reason:
An agent that skips 'help plan' may emit malformed JSON on the first required call; bounded because omission is accepted, but a guessed value still causes an avoidable error and retry.
Solution:
Add a short inline cue pointing to 'help plan' for the JSON shape and state a safe empty-array fallback; mark optional if it is optional.
⚪ Low Precision & Explicitness Problem:
Same as bootstrap.md: the JSON-string arg is quoted as "<PHASE_STEPS_JSON_STRING>" on create-with-template but unquoted as on the upsert-with-template delegation line.
Reason:
The unquoted exemplar models a call that could break shell argument parsing if copied literally.
Solution:
Quote both occurrences consistently to match the commands-list style.

📊 Gates Comparison

Gate Score Comparison
Input Contract 4 ⬆️ Slightly better
Decision Branching 4 ⬆️ Slightly better
Precision & Explicitness 4 ⬆️ Slightly better
Reference Integrity 5 ⬆️ Slightly better
Structural Coherence 5 ⬆️ Slightly better
Bloat Control 5 ⬆️ Slightly better

@ymakaruk-pixel ymakaruk-pixel force-pushed the CTORNDGAIN-1301-FAQ-terminology-readme branch 5 times, most recently from 917c851 to 0f710d8 Compare June 10, 2026 15:19
Comment thread QUICKSTART.md Outdated

### Automated QA

**WHAT**: Automate one UI test at a time from a TestRail case, reusing your existing Page Objects and selectors. Scope each run to a single test case or feature — never ask it to automate everything at once.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Utterly specific. And at the same time not showing what AQA actually is. The workflow is not per page or single test case. That is aweful description. Please talk to Maksym and keep it similar to the one we have for coding. Simple and easy.

@ymakaruk-pixel ymakaruk-pixel force-pushed the CTORNDGAIN-1301-FAQ-terminology-readme branch 2 times, most recently from 7135300 to d109b44 Compare June 12, 2026 13:29
Comment thread README.md Outdated
@@ -27,31 +27,24 @@ Every AI interaction follows four phases: **Prepare** (load guardrails and conte

## Supported IDEs and Agents

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's call it Quick Start
Merge it with existing quickstart
use warning for that note
Format
Quick Start
Two Ways:

  1. Plugins (recommended):[Link to install] [LIST of IDEs]
  2. MCP: [Link to install] [LIST of IDEs]

@ymakaruk-pixel ymakaruk-pixel force-pushed the CTORNDGAIN-1301-FAQ-terminology-readme branch 3 times, most recently from 690708f to 82208e8 Compare June 17, 2026 09:08
Comment thread README.md
</div>

## What is Rosetta
Rosetta gives an AI coding agent the context and instructions any senior engineer would need before touching the code. As the result, AI agents work from real knowledge of your project instead of guessing. Rosetta feeds the agent your system architecture, domain rules, and engineering standards, plus a library of ready-made instructions to follow. Those instructions include:

@isolomatov-gd isolomatov-gd Jun 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please match that with our elevator speech in the repo.

@ymakaruk-pixel ymakaruk-pixel force-pushed the CTORNDGAIN-1301-FAQ-terminology-readme branch from 82208e8 to 7248b66 Compare June 18, 2026 08:35
Reader profiles, per-document contracts, and a profile-based reading
journey. Un-ignore the file so it travels with the PR.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation needs more work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants