Skip to content

fix: revamped remaining top traffic pages#370

Merged
gorakhnathy7 merged 2 commits into
mainfrom
top-traffic-pages-batch-2
May 22, 2026
Merged

fix: revamped remaining top traffic pages#370
gorakhnathy7 merged 2 commits into
mainfrom
top-traffic-pages-batch-2

Conversation

@gorakhnathy7
Copy link
Copy Markdown
Contributor

Summary

Applies a consistent gold-docs treatment across the highest-traffic pages in the docs. Focus is on structure, correctness, and discoverability — content meaning is preserved.

Patterns applied across every page:

  • title: + description: frontmatter
  • Single H1
  • "Need some help?" footer block (Slack + support)
  • Em dashes removed; body --- section separators removed
  • Internal links use .md extensions and index.md for directory targets
  • Inline warning/note prose converted to !!! admonitions
  • "Next steps" sections added to drive readers to logical follow-ups
  • Video embeds wrapped in !!! tip "Video walkthrough" admonitions

Pages touched

Page Key change
docs/administration/maintenance/storage-management/storage.md H1, frontmatter title, quick-reference provider table, etcd dead-config removed, env var corrections (ZO_LOCAL_MODE), heading casing fixes (OpenStack Swift, Aliyun, Azure Blob), GCS bold pseudo-headings promoted to ####
docs/enterprise-setup/performance.md Trailing-colon and trailing-space cleanups on headings, version notes lifted out of headings into !!! note admonitions, all >Note: blockquotes converted to admonitions, Next steps added
docs/enterprise-setup/sre-agent.md H1, numbered Feature headings unnumbered, broken bullet fixed, external doc URLs converted to internal relatives, Configuration Flows promoted to subheadings, whole Troubleshooting section wrapped in one ??? collapsible (5 numbered issues inside), Prerequisites enriched with quota note + O2_AI_ENABLED requirement, standard footer
docs/features/enterprise.md Frontmatter, "Get started" CTA section, Next steps section, bold-inside-link cleanup on all feature links
docs/features/metrics.md Frontmatter, italic caption merged into hero alt text, consistent bullet punctuation, "Metric Structure" heading rename, "Get started" CTA + Next steps
docs/ingestion/logs/syslog.md Entire legacy syslog content wrapped in ??? "Legacy reference (pre-August 2025)" so the deprecation warning leads the page, shellbash fences, video in tip admonition
docs/ingestion/logs/vector.md Stranded ( .toml format) artifact removed, ### NOTE heading-as-note converted to admonition, placeholder substitution + sink-type picker added, Verify Ingestion + Next steps sections
docs/ingestion/traces/opentelemetry.md Brand-name typos fixed (TypeScript, JavaScript (Node.js), OpenTelemetry), trace ingestion endpoint section added, Prerequisites, Next steps
docs/integration/ai/mcp/index.md Frontmatter title, untitled !!! note admonitions retitled, multi-org section clarified for all clients, "Resources" replaced with proper Next steps + standard footer
docs/overview/comparison.md Frontmatter, ## Elasticsearch Compatibility standalone section folded into the Elasticsearch comparison with a sentence on why it matters
docs/reference/api/.pages Added Overview: index.md so the API Reference landing page appears in the nav
docs/reference/api/index.md Frontmatter, > blockquote-as-code auth examples converted to fenced code blocks, all sub-links given .md / index.md extensions, Next steps
docs/reference/api/search/search.md Frontmatter title, {stream} placeholder note, duplicate "Query latest 10 record logs" example removed, English typos fixed (filedfield, Something need highlighted:Notes:), Next steps
docs/reference/sql-functions/full-text-search.md H1, 5 body --- separators removed, all <br> tags stripped, function index table added at top, !!! Note!!! note, MCP-style consistency tweaks, pattern types under match_all converted to a 3-column table, **Important** inline note promoted to !!! warning, Next steps
docs/reference/sql-functions/index.md Frontmatter, H1, expanded function category list (Full-Text Search, Secondary Index, Array, Aggregate, Approximate Aggregate with nested links for Overview, approx_topk, approx_topk_distinct), proper link extensions, standard footer
docs/releases.md Frontmatter title, three external links restructured into a Type / Location / Notes table
docs/user-guide/analytics/alerts/index.md Frontmatter title, H1, all 8 em dashes in "Learn more" removed, all 7 body --- separators removed, "Learn more" → ## Next steps, trailing-slash directory paths fixed

Tests ran on local

@gorakhnathy7 gorakhnathy7 merged commit 7077693 into main May 22, 2026
1 check passed
@gorakhnathy7 gorakhnathy7 deleted the top-traffic-pages-batch-2 branch May 22, 2026 13:40
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