Skip to content

RDBTC-221 Migrate Technical Guides: Writing unit tests with RavenDB .NET Test Driver#2514

Open
Netzach-Nyss wants to merge 1 commit into
ravendb:mainfrom
Netzach-Nyss:RDBTC-221-1
Open

RDBTC-221 Migrate Technical Guides: Writing unit tests with RavenDB .NET Test Driver#2514
Netzach-Nyss wants to merge 1 commit into
ravendb:mainfrom
Netzach-Nyss:RDBTC-221-1

Conversation

@Netzach-Nyss

Copy link
Copy Markdown
Contributor

Issue link

RDBTC-221 Migrate technical guides and how-tos from ravend.net/articles to docs.ravendb.net/guides

Additional description

Migrating Article "Writing unit tests with RavenDB .NET Test Driver" and it's image.

Content Quality Score: 71/100 | AI Citation Readiness: 58/100


E-E-A-T Breakdown

Factor Score Key Signals
Experience 15/25 First-person team voice, Studio screenshot; no real-world scale or failure anecdotes
Expertise 18/25 Technically accurate; no using directives in samples, disposal not explained
Authoritativeness 14/25 First-party links valid; no version numbers, no GitHub/changelog links
Trustworthiness 24/25 Named author, date, real FAQ error; FAQ answer doesn't specify which dotnet version to install

Issues Found

P1 (High) — Contractor class used in Steps 3 & 4 but never defined
Contractor with FirstName/LastName is stored in Steps 3 and 4 but has no class definition in the guide. Customer and Location are defined before Step 5. Beginners have nothing to reference.

P2 (High) — No using directives in any code sample
using Raven.TestDriver;, using Raven.Client.Documents;, using Xunit; missing everywhere. A beginner copying the first snippet gets CS0246 immediately.

P3 (High) — Conclusion is marketing boilerplate
"Elevate your testing practices to new heights" / "Embrace the power..." — flagged as low-quality AI content markers per Sept 2025 QRG.

P4 (Medium) — No version anchor in prose
NuGet install command unpinned, body text never states RavenDB 7.x target.

P5 (Medium) — WaitForUserToContinueTheTest caveat incomplete
Says it only works with debugger attached but doesn't say it's silently skipped in CI — a real gotcha.

P6 (Medium) — License section has no code example
Tells readers to set RAVEN_LICENSE but gives no shell snippet or xUnit injection pattern.

P7 (Low) — Step 2 sub-heading redundancy
#### Step 2: Creating a test case... duplicates the parent ### 2. number label.


Type of change

  • Content - docs
  • Content - cloud
  • Content - guides
  • Content - start pages/other
  • New docs feature (consider updating /templates or readme)
  • Bug fix
  • Optimization
  • Other

Changes in docs URLs

  • No changes in docs URLs
  • Articles are restructured, URLs will change, mapping is required (update /scripts/redirects.json file, set Documents Moved PR label)

Changes in UX/UI

  • No changes in UX/UI
  • Changes in UX/UI (include screenshots and description)

@poissoncorp

Copy link
Copy Markdown
Contributor

Please fix P1-P3

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