RDBTC-221 Migrate technical guides Migrating RDBTC-85 - #2629
Open
Netzach-Nyss wants to merge 1 commit into
Open
Conversation
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.
Issue link
RDBTC-85 How to troubleshoot high CPU usage
RDBTC-221 Migrate technical guides and how-tos from ravend.net/articles to docs.ravendb.net/guides
Additional description
Content Quality Score: 82/100
(previous pass: 68/100)
Verified against the rendered build output at
build/guides/how-to-troubleshoot-ravendbs-high-cpu-usage/index.html, not just the source.Measured metrics
Keyword profile is healthy:
cpu2.69%,current cpu usage1.10%,total cpu time0.92%,high cpu usage0.92%. All within the 1-3% natural band with no stuffing.cpu,ravendb, andhigh cpu usageall appear in the first 100 words.E-E-A-T Breakdown
jobTitle: Technical WriterandworksFor: RavenDB. Only 2 external citationssee_alsofixed, truncated sentence and malformed table gone. Verified visible byline in rendered HTML: "Paweł Lachowski, Technical Writer, Published on February 23, 2025". Canonical correct, no straynoindex. Loses points for no visible update dateTotal: 83/100 (was 71/100)
AI Citation Readiness: 72/100
(previous pass: 58/100)
Gained: a parseable comparison table, consistent entity naming, parallel definition patterns ("Current CPU Usage (In RavenDB called Current CPU %)" / "Total CPU Time (in RavenDB called Overall CPU Time)"), and a verified five-block entity graph.
Still capped by: no Q&A blocks, an intro that answers nothing, zero statistics, and one section (Windows) that poses a question and declines to answer it.
Issues Found
New this pass
1. Guide
tagsnever reach schemakeywords. The rendered TechArticle haskeywords: Nonedespite frontmattertags: [perf-tuning, troubleshooting, deep-dive]. Cause: index.tsx:139 passeskeywords={frontMatter.keywords}, but guides declaretags:, notkeywords:. Only 3 of 77 guides define akeywordsfield, so this path is effectively dead site-wide. Samples handle it correctly by mapping their three tag arrays intokeywords. This is a one-line fix in the theme component that would populate keywords across all 77 guides, not just this one.2. No visible "last updated" date. Schema carries
dateModified: 2026-05-22againstdatePublished: 2025-02-23, but the rendered page shows only "Published on February 23, 2025". Readers and quality raters see an 18-month-old date with no revision marker, on a topic whose screenshots are version-sensitive. The signal is already earned in schema; it just isn't surfaced.3.
proficiency_level: Expertis in schema but not rendered. Minor, but it is a relevance cue that costs nothing to display.4. Inline link density is 5.5 per 1,000 words, just above the 3-5 guideline. Not a defect, and all nine are contextually relevant. Flagging only so no more get added.
Carried over (the items deferred by scope)
5. Windows section is still a dead end. Unchanged, and now the single clearest weakness. It remains the only place where the guide raises a question and supplies no answer, which costs on both Expertise and AI citation.
6. No FAQ section. The largest remaining GEO lever.
7. Intro is not answer-first, and still opens with a sentence fragment ("Whether you noticed it on the RavenDB dashboard or started investigating why your tasks take so long to finish.").
8. Zero statistics or first-party data. No CPU percentages, no "normal looks like X" baseline, no timings. First-party data is among the most-cited content types by AI systems, and this guide has none.
9. "troubleshoot" appears 0 times in the body despite being in the title, slug, and H1.
10. No
image:frontmatter. Confirmed low impact:og:imageis a fixed site-wide card regardless, so this only affectsFeaturedGuidesplacement.Recommendations
Ranked by impact per effort:
keywordsmapping in the theme component. Cheapest fix on the list, and it improves all 77 guides at once rather than this one.Items 1, 2, and 5 are the substantive ones. Items 3, 4, 6 are mechanical.
Type of change
/templatesor readme)Changes in docs URLs
/scripts/redirects.jsonfile, setDocuments MovedPR label)Changes in UX/UI