Unverified Commit ece08dc9 authored by Neal Vaidya's avatar Neal Vaidya Committed by GitHub
Browse files

docs: restructure docs directory and move fern config to fern/ (#6700)


Signed-off-by: default avatarNeal Vaidya <nealv@nvidia.com>
Co-authored-by: default avatarClaude Opus 4.6 <noreply@anthropic.com>
parent 1412e44b
...@@ -8,7 +8,7 @@ Dynamo supports multimodal generation through the [vLLM-Omni](https://github.com ...@@ -8,7 +8,7 @@ Dynamo supports multimodal generation through the [vLLM-Omni](https://github.com
## Prerequisites ## Prerequisites
This guide assumes familiarity with deploying Dynamo with vLLM as described in the [vLLM backend guide](/docs/pages/backends/vllm/README.md). This guide assumes familiarity with deploying Dynamo with vLLM as described in the [vLLM backend guide](README.md).
### Installation ### Installation
...@@ -189,7 +189,7 @@ For S3 credential configuration, set the standard AWS environment variables (`AW ...@@ -189,7 +189,7 @@ For S3 credential configuration, set the standard AWS environment variables (`AW
## Stage Configuration ## Stage Configuration
Omni pipelines are configured via YAML stage configs. See [`examples/backends/vllm/launch/stage_configs/single_stage_llm.yaml`](/examples/backends/vllm/launch/stage_configs/single_stage_llm.yaml) for an example. For full documentation on stage config format and multi-stage pipelines, refer to the [vLLM-Omni Stage Configs documentation](https://docs.vllm.ai/projects/vllm-omni/en/latest/configuration/stage_configs/). Omni pipelines are configured via YAML stage configs. See [`examples/backends/vllm/launch/stage_configs/single_stage_llm.yaml`](https://github.com/ai-dynamo/dynamo/blob/main/examples/backends/vllm/launch/stage_configs/single_stage_llm.yaml) for an example. For full documentation on stage config format and multi-stage pipelines, refer to the [vLLM-Omni Stage Configs documentation](https://docs.vllm.ai/projects/vllm-omni/en/latest/configuration/stage_configs/).
## Current Limitations ## Current Limitations
......
...@@ -98,7 +98,7 @@ kubectl create secret generic hf-token-secret \ ...@@ -98,7 +98,7 @@ kubectl create secret generic hf-token-secret \
### Step 1.3: Install Dynamo Platform (Per-Namespace) ### Step 1.3: Install Dynamo Platform (Per-Namespace)
If your cluster uses namespace-restricted Dynamo operators, you'll need to install the Dynamo platform in each namespace. Follow the [Dynamo Kubernetes Installation Guide](https://github.com/ai-dynamo/dynamo/blob/main/docs/pages/kubernetes/installation-guide.md) to install the platform in both namespaces: If your cluster uses namespace-restricted Dynamo operators, you'll need to install the Dynamo platform in each namespace. Follow the [Dynamo Kubernetes Installation Guide](https://github.com/ai-dynamo/dynamo/blob/main/docs/kubernetes/installation-guide.md) to install the platform in both namespaces:
- `router-off-test` - `router-off-test`
- `router-on-test` - `router-on-test`
......
...@@ -24,15 +24,15 @@ description: A one-sentence summary shown in search results and social previews. ...@@ -24,15 +24,15 @@ description: A one-sentence summary shown in search results and social previews.
## Step 2: Add the Post to Navigation ## Step 2: Add the Post to Navigation
Open `docs/versions/dev.yml` and add a page entry under the **Blog** section: Open `docs/index.yml` and add a page entry under the **Blog** section:
```yaml ```yaml
- section: Blog - section: Blog
path: ../blogs/index.mdx path: blogs/index.mdx
slug: blog slug: blog
contents: contents:
- page: Your Blog Post Title - page: Your Blog Post Title
path: ../blogs/my-post-slug.md path: blogs/my-post-slug.md
``` ```
Each new post gets a `- page:` entry in the `contents` list. The `page` Each new post gets a `- page:` entry in the `contents` list. The `page`
...@@ -68,7 +68,7 @@ Browse icons at https://fontawesome.com/icons (Free tier). ...@@ -68,7 +68,7 @@ Browse icons at https://fontawesome.com/icons (Free tier).
## Step 4 (Optional): Add the Post to the Navbar Dropdown ## Step 4 (Optional): Add the Post to the Navbar Dropdown
Open `docs/docs.yml` and add a link under the Blog dropdown in `navbar-links`: Open `fern/docs.yml` and add a link under the Blog dropdown in `navbar-links`:
```yaml ```yaml
navbar-links: navbar-links:
...@@ -88,6 +88,6 @@ accessible from the landing page and sidebar. ...@@ -88,6 +88,6 @@ accessible from the landing page and sidebar.
## Quick Checklist ## Quick Checklist
- [ ] Blog post `.md` file created in `docs/blogs/` - [ ] Blog post `.md` file created in `docs/blogs/`
- [ ] Page entry added to `docs/versions/dev.yml` under the Blog section - [ ] Page entry added to `docs/index.yml` under the Blog section
- [ ] Card added to `docs/blogs/index.mdx` - [ ] Card added to `docs/blogs/index.mdx`
- [ ] (Optional) Link added to the Blog dropdown in `docs/docs.yml` - [ ] (Optional) Link added to the Blog dropdown in `fern/docs.yml`
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment