.nav.yml 1.75 KB
Newer Older
1
2
3
4
5
6
7
nav:
  - Home: 
    - vLLM: README.md
    - Getting Started:
      - getting_started/quickstart.md
      - getting_started/installation
    - Examples:
8
9
10
      - Offline Inference: examples/offline_inference
      - Online Serving: examples/online_serving
      - Others: examples/others
11
    - Quick Links:
12
13
      - User Guide: usage/README.md
      - Developer Guide: contributing/README.md
14
15
16
17
      - API Reference: api/README.md
    - Timeline:
      - Roadmap: https://roadmap.vllm.ai
      - Releases: https://github.com/vllm-project/vllm/releases
18
  - User Guide:
Cyrus Leung's avatar
Cyrus Leung committed
19
    - Summary: usage/README.md
20
    - usage/v1_guide.md
21
22
    - General:
      - usage/*
23
24
25
26
27
28
29
30
31
    - Inference and Serving:
      - serving/offline_inference.md
      - serving/openai_compatible_server.md
      - serving/*
      - serving/integrations
    - Deployment:
      - deployment/*
      - deployment/frameworks
      - deployment/integrations
32
33
34
35
    - Training: training
    - Configuration:
      - Summary: configuration/README.md
      - configuration/*
36
37
38
39
40
41
42
43
44
45
    - Models:
      - models/supported_models.md
      - models/generative_models.md
      - models/pooling_models.md
      - models/extensions
    - Features:
      - features/compatibility_matrix.md
      - features/*
      - features/quantization
  - Developer Guide:
Cyrus Leung's avatar
Cyrus Leung committed
46
    - Summary: contributing/README.md
47
48
49
    - General:
      - glob: contributing/*
        flatten_single_child_sections: true
50
    - Model Implementation: contributing/model
51
52
53
54
    - Design Documents:
      - V0: design
      - V1: design/v1
  - API Reference:
Cyrus Leung's avatar
Cyrus Leung committed
55
56
57
58
    - Summary: api/README.md
    - Contents:
      - glob: api/vllm/*
        preserve_directory_names: true
59
60
  - Community:
    - community/*
61
62
63
    - Blog: https://blog.vllm.ai
    - Forum: https://discuss.vllm.ai
    - Slack: https://slack.vllm.ai