Skip to main content

Yeni Ürün Ekleme Rehberi

Bu rehber, dokümantasyon sitesine yeni bir ürün eklemeyi adım adım açıklar.

Mevcut Yapı​

roltek-documentation/
├── docs/                    # Ana dokümantasyon (intro, rehberler)
├── routers/                 # Ürün dokümantasyonları
│   ├── rltk541/
│   │   ├── sidebars.js     # RLTK541 sidebar
│   │   └── overview.md
│   ├── rltk421/
│   │   ├── sidebars.js     # RLTK421 sidebar
│   │   └── overview.md
│   └── rltk451/
│       ├── sidebars.js     # RLTK451 sidebar
│       └── overview.md
├── sidebars.ts             # Ana sidebar
└── docusaurus.config.ts    # Ana konfigürasyon

Adım 1: Ürün Klasörü Oluşturma​

routers/ altında yeni klasör oluşturun:

mkdir routers/URUN_KODU

Örnek: RLT500 için:

mkdir routers/rlt500

Adım 2: Kategori Dosyası Oluşturma​

routers/rlt500/_category_.json:

{
  "label": "RLT500 Router",
  "position": 1,
  "link": {
    "type": "generated-index",
    "description": "RLT500 Router dokümantasyonu"
  }
}

Adım 3: Overview Sayfası Oluşturma​

routers/rlt500/overview.md:

---
id: overview
title: RLT500 Router
sidebar_position: 1
---

# RLT500 Router

Ürün açıklaması...

## Özellikler

- Özellik 1
- Özellik 2

Adım 4: Sidebar Dosyası Oluşturma​

routers/rlt500/sidebars.js:

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  rlt500Sidebar: [
    {
      type: 'autogenerated',
      dirName: '.',
    },
  ],
};

module.exports = sidebars;

Adım 5: Docusaurus Konfigürasyonu​

docusaurus.config.ts dosyasında:

5.1 Plugin Ekleme​

plugins dizisine ekleyin:

plugins: [
  // ... mevcut pluginler ...
  [
    '@docusaurus/plugin-content-docs',
    {
      id: 'rlt500',
      path: 'routers/rlt500',
      routeBasePath: 'docs/rlt500',
      sidebarPath: './routers/rlt500/sidebars.js',
    },
  ],
],

5.2 Navbar'a Ekleme​

themeConfig.navbar.items içindeki routers dropdown'una:

{
  type: 'dropdown',
  label: 'routers',
  items: [
    // ... mevcut ürünler ...
    {
      type: 'doc',
      docsPluginId: 'rlt500',
      docId: 'overview',
      label: 'RLT500 Router',
    },
  ],
},

Adım 6: Build ve Test​

rm -rf .docusaurus
npm run build
npm run serve

Ek Sayfalar Ekleme​

routers/rlt500/ klasörüne yeni .md dosyaları ekleyin:

routers/rlt500/
├── _category_.json
├── overview.md
├── kurulum.md
├── konfigürasyon.md
└── api/
    ├── _category_.json
    └── rest-api.md

Özet Checklist​

  • routers/URUN/ klasörü oluştur
  • _category_.json ekle
  • overview.md ekle
  • sidebars.js ekle (aynı klasöre)
  • docusaurus.config.ts - plugin ekle
  • docusaurus.config.ts - navbar'a ekle
  • Build ve test et