Skip to content

v2.0.0 — Modern Interactive Bilingual Documentation & Coordinate Review System

Latest
Latest

Choose a tag to compare

View all tags
@ghasemdev ghasemdev released this 03 Oct 10:57
2.0.0
3a3dc86

🚀 What's New in v2.0.0

📍 Universal Coordinate Pin Commenting & Bilingual Review Drawer

  • Global Pin Drop System: Readers can click 📍 in the toolbar to activate pin mode and drop numbered feedback pins at any $(x%, y%)$ coordinate across the entire document.
  • Slide-Out Review Drawer: Replaced static overlays with a full-height drawer ("Review Comments" / "نظرات بازبینی") displaying all dropped pins, coordinates, and section tags.
  • Interactive "Jump to Pin": Smoothly scrolls to the targeted element and pulses the pin marker for quick visual reference.
  • AI-Ready JSON Export & HTML Persistence: 1-click export of structured comment data for AI refinement (📥 Export JSON), plus client-side HTML self-persistence (💾 Save & Embed in HTML).

📑 Standardized 5-Part API Documentation Specification

  1. Endpoint Title & Business Description: Clear purpose and business context at the top of the card.
  2. HTTP Method Badge & URL Bar: High-contrast method badges (POST, GET, PUT, DELETE) with 1-click copy button.
  3. Parameters Table: Parameter Name, Type, Placement/Required, Description, and Example values.
  4. Strictly LTR JSON Payloads: Request and response schemas with syntax highlighting and copy buttons.
  5. Status & Error Codes Table: HTTP status codes, error keys, and mitigation/resolution guidance.

🌐 Bilingual Typography & RTL Enhancements

  • Strictly LTR Code & Links in Persian Mode: All <pre>, <code>, JSON previews, technical URLs, and reference links remain strictly Left-to-Right (direction: ltr !important; text-align: left !important;) to prevent character scrambling and inverted slashes/dots in RTL mode.
  • RTL Catalog Navigation: Section numbers in the catalog sidebar are positioned on the far right in Persian mode (order: 1 in RTL flex row), and title on the left.
  • Persian Writing Compliance: Vazirmatn font, strict ZWNJ (نیم‌فاصله), Persian numerals, and elimination of bureaucratic phrasing.

🔄 Multi-Version Navigation (Zero 404s)

  • Live Version Switching: Instant switching between versions (v2.0.0, v1.2.0, v1.0.0) in the top navbar.
  • Dynamic Relative Path Resolution: Automatic base URL detection prevents 404 errors on GitHub Pages and nested directories.
  • Archived Version Banners: Older versions display prominent warning banners directing users to the latest release.

📱 Flawless Mobile Responsiveness (Zero Overflow)

  • Permanently Fixed Navbar: Top navbar stays fixed on mobile screens during scrolling.
  • Zero Desktop Gap: Seamless alignment between toolbar and catalog sidebar (desktopGap: 0px).
  • Isolated Button Classes: Dedicated .btn-modal, .btn-drawer, and .btn-jump-pin styles prevent button squashing, text truncation, or drawer overflowing on viewports down to 320px.
  • Guaranteed Table Scroll: All tables maintain horizontal scrollbars with min-width: 650px !important; to protect data columns from crushing.

🛠️ Production-Ready Starter Template

  • resources/starter-template.html is fully synchronized with the reference implementation and ready for immediate scaffolding of new documentation projects.
Assets 2
Loading