Skip to content

Website documentation review and improvements#107

Merged
em3s merged 12 commits intomainfrom
docs/review-2026-01-24
Jan 24, 2026
Merged

Website documentation review and improvements#107
em3s merged 12 commits intomainfrom
docs/review-2026-01-24

Conversation

@em3s
Copy link
Copy Markdown
Contributor

@em3s em3s commented Jan 24, 2026

Summary

  • Improve landing page tagline and cards for clarity
  • Add WIP indicators for incomplete documentation (Kubernetes, HBase, FOMO, Gifting guides)
  • Update Schema documentation with v2/v3 terminology mapping
  • Add API References overview page with shared Authentication section
  • Unify API reference tone with Aside components
  • Add mobile hero image sizing
  • Add llms.txt feedback section
  • Sync Korean translations
  • Use consistent "over a million requests per minute" phrasing

Changes

Landing Page

  • Updated tagline: "One store for likes, views, and follows — pre-computed, served in real-time"
  • Restructured cards to focus on differentiators

API References

  • Created overview page (api-references/index.mdx) with Base URL and Authentication sections
  • Unified tone across Metadata, Mutation, Query APIs using Aside components
  • Added explanation for CustomTokenFilter authentication abstraction

Schema Documentation

  • Use v2 terminology (current API) with v3 annotations in parentheses
  • Added full v2/v3 mapping table in Schema and Glossary

WIP Indicators

  • Added sidebar opacity (0.5) for WIP items
  • Added "This guide is being prepared" notices

Traffic Metrics Phrasing

  • Replaced specific metrics (1M, 2M) with "over a million requests per minute" for consistency
  • Kept exact numbers in benchmarks page

🤖 Generated with Claude Code

em3s and others added 11 commits January 24, 2026 18:29
- Update tagline: "One store for likes, views, and follows — pre-computed, served in real-time"
- Restructure cards to highlight key differentiators
- Add responsive hero image sizing for mobile
- Sync Korean translation

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- CLI: add preview notice in document header
- Kubernetes, HBase: add "being prepared" notice
- FOMO, Gifting guides: add "being prepared" notice
- Style WIP items with reduced opacity in sidebar

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Use v3 terms: database, table, source, target, properties, direction, indexes, comment
- Add v2/v3 mapping table for reference
- Update schema structure based on core-java v3 metadata

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Use v2 terms as primary (current Schema API)
- Add v3 terms in parentheses for reference
- Note that most docs use v3, but Schema uses v2

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Metadata, Mutation, Query: Use Aside instead of > **Note:**
- Add cross-reference to Schema for terminology mapping

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Explain why auth was removed for open source release
- Reference CustomTokenFilter interface abstraction
- Link from mutation/query APIs to metadata auth section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Create api-references/index.mdx as overview page
- Move authentication explanation to shared location
- Update all API docs to reference the shared auth section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation module:website labels Jan 24, 2026
Replace specific metrics (1M, 2M) with general 'over a million' expression
for consistency across documentation while keeping exact numbers in benchmarks.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@em3s em3s merged commit 7200ee1 into main Jan 24, 2026
10 checks passed
@em3s em3s self-assigned this Jan 26, 2026
@em3s em3s changed the title docs: website documentation review and improvements Website documentation review and improvements Feb 12, 2026
@em3s em3s deleted the docs/review-2026-01-24 branch March 1, 2026 12:59
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 size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant