Skip to content

Commit 224926d

Browse files
apartsinclaude
andcommitted
docs: standardize all markdown links to use .md extension
Bulk-convert 553 internal links across 72 documentation files from .html to .md extension. Markdown files now link to .md (rendered by GitHub natively), while HTML <a> tags retain .html (for GitHub Pages). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 6de45ba commit 224926d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+375
-375
lines changed

docs/CHANGELOG.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,28 @@ All issues found and fixes applied during the 5 review cycles of the ModelMesh L
1919

2020
| File | Issue | Fix |
2121
| --- | --- | --- |
22-
| `SystemConcept.md` | Referenced `ProviderSchemas.md` which does not exist (lines 101, 248) | Replaced with `[Provider Interface](interfaces/Provider.html)` and removed redundant footer reference |
22+
| `SystemConcept.md` | Referenced `ProviderSchemas.md` which does not exist (lines 101, 248) | Replaced with `[Provider Interface](interfaces/Provider.md)` and removed redundant footer reference |
2323

2424
### Root Docs Missing Subfolder References (4 fixes)
2525

2626
| File | Fix |
2727
| --- | --- |
2828
| `SystemConcept.md` | Updated footer to mention `system/Overview.md`, `interfaces/Provider.md`, `connectors/openai-llm.md` as entry points |
29-
| `SystemServices.md` | Added link: "Individual service documentation with full code definitions is in [system/](system/Overview.html)." |
30-
| `ConnectorInterfaces.md` | Added link: "Full interface definitions with code are in [interfaces/](interfaces/Provider.html)." |
31-
| `ConnectorCatalogue.md` | Added link: "Individual connector documentation is in [connectors/](connectors/openai-llm.html)." |
29+
| `SystemServices.md` | Added link: "Individual service documentation with full code definitions is in [system/](system/Overview.md)." |
30+
| `ConnectorInterfaces.md` | Added link: "Full interface definitions with code are in [interfaces/](interfaces/Provider.md)." |
31+
| `ConnectorCatalogue.md` | Added link: "Individual connector documentation is in [connectors/](connectors/openai-llm.md)." |
3232

3333
### System Docs Pointing to Root Instead of Local Docs (7 fixes)
3434

3535
| File | Old Link | New Link |
3636
| --- | --- | --- |
37-
| `system/ConnectorRegistry.md` | `[ModelMesh](../SystemServices.html#modelmesh)` | `[ModelMesh](ModelMesh.html)` |
38-
| `system/DeactivationEvaluator.md` | `[ModelState](../SystemServices.html#modelstate), [RotationPolicy](../SystemServices.html#rotationpolicy)` | `[ModelState](ModelState.html), [RotationPolicyService](RotationPolicyService.html)` |
39-
| `system/ModelRegistry.md` | `[CapabilityPool](../SystemServices.html#capabilitypool)` | `[CapabilityPool](CapabilityPool.html)` |
40-
| `system/OpenAIClient.md` | `[Router](../SystemServices.html#router)` | `[Router](Router.html)` |
41-
| `system/ProxyServer.md` | `[Router](../SystemServices.html#router), [ModelMesh](../SystemServices.html#modelmesh)` | `[Router](Router.html), [ModelMesh](ModelMesh.html)` |
42-
| `system/RecoveryEvaluator.md` | `[ModelState](../SystemServices.html#modelstate), [RotationPolicy](../SystemServices.html#rotationpolicy)` | `[ModelState](ModelState.html), [RotationPolicyService](RotationPolicyService.html)` |
43-
| `system/SelectionStrategy.md` | `[RotationPolicy](../SystemServices.html#rotationpolicy), [CapabilityPool](../SystemServices.html#capabilitypool)` | `[RotationPolicyService](RotationPolicyService.html), [CapabilityPool](CapabilityPool.html)` |
37+
| `system/ConnectorRegistry.md` | `[ModelMesh](../SystemServices.md#modelmesh)` | `[ModelMesh](ModelMesh.md)` |
38+
| `system/DeactivationEvaluator.md` | `[ModelState](../SystemServices.md#modelstate), [RotationPolicy](../SystemServices.md#rotationpolicy)` | `[ModelState](ModelState.md), [RotationPolicyService](RotationPolicyService.md)` |
39+
| `system/ModelRegistry.md` | `[CapabilityPool](../SystemServices.md#capabilitypool)` | `[CapabilityPool](CapabilityPool.md)` |
40+
| `system/OpenAIClient.md` | `[Router](../SystemServices.md#router)` | `[Router](Router.md)` |
41+
| `system/ProxyServer.md` | `[Router](../SystemServices.md#router), [ModelMesh](../SystemServices.md#modelmesh)` | `[Router](Router.md), [ModelMesh](ModelMesh.md)` |
42+
| `system/RecoveryEvaluator.md` | `[ModelState](../SystemServices.md#modelstate), [RotationPolicy](../SystemServices.md#rotationpolicy)` | `[ModelState](ModelState.md), [RotationPolicyService](RotationPolicyService.md)` |
43+
| `system/SelectionStrategy.md` | `[RotationPolicy](../SystemServices.md#rotationpolicy), [CapabilityPool](../SystemServices.md#capabilitypool)` | `[RotationPolicyService](RotationPolicyService.md), [CapabilityPool](CapabilityPool.md)` |
4444

4545
### Unlinked Plain-Text Dependencies (13 fixes)
4646

@@ -53,11 +53,11 @@ Added markdown links for plain-text "Depends on" entries in 13 system docs:
5353
| File | Fix |
5454
| --- | --- |
5555
| `system/Overview.md` | Added links for 10 services in the Service Groupings table |
56-
| `system/RoutingPipeline.md` | Changed plain-text `SelectionStrategy` to `[SelectionStrategy](SelectionStrategy.html)` |
56+
| `system/RoutingPipeline.md` | Changed plain-text `SelectionStrategy` to `[SelectionStrategy](SelectionStrategy.md)` |
5757

5858
### Missing Interface References in Rotation Connectors (4 fixes)
5959

60-
Added `See [ConnectorInterfaces.md -- Rotation Policy](../ConnectorInterfaces.html#rotation-policy)...` to:
60+
Added `See [ConnectorInterfaces.md -- Rotation Policy](../ConnectorInterfaces.md#rotation-policy)...` to:
6161

6262
`connectors/modelmesh-priority-selection.md`, `connectors/modelmesh-session-stickiness.md`, `connectors/modelmesh-rate-limit-aware.md`, `connectors/modelmesh-load-balanced.md`
6363

docs/ConnectorCatalogue.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ title: "Connector Catalogue"
55

66
# Connector Catalogue
77

8-
**Pre-shipped connector implementations for ModelMesh Lite.** Each section lists available implementations for one connector type. Individual connector documentation is in [connectors/](connectors/openai-llm.html). Interface definitions are in [ConnectorInterfaces.md](ConnectorInterfaces.html). Custom connectors implement the same interfaces and register in the same catalogue (see [Developer Manual](SystemConcept.html#connector-based-extensibility)).
8+
**Pre-shipped connector implementations for ModelMesh Lite.** Each section lists available implementations for one connector type. Individual connector documentation is in [connectors/](connectors/openai-llm.md). Interface definitions are in [ConnectorInterfaces.md](ConnectorInterfaces.md). Custom connectors implement the same interfaces and register in the same catalogue (see [Developer Manual](SystemConcept.md#connector-based-extensibility)).
99

10-
> **Building custom connectors?** The [Connector Development Kit](cdk/Overview.html) provides base classes and tutorials for creating new connectors with minimal code.
10+
> **Building custom connectors?** The [Connector Development Kit](cdk/Overview.md) provides base classes and tutorials for creating new connectors with minimal code.
1111
1212
> Pricing and availability change frequently; consult each provider's documentation for current details.
1313
@@ -36,13 +36,13 @@ In YAML configuration, the `connector_type.` prefix is omitted within its own se
3636

3737
## Provider Connectors
3838

39-
Interface: [ConnectorInterfaces.md — Provider](ConnectorInterfaces.html#provider)
39+
Interface: [ConnectorInterfaces.md — Provider](ConnectorInterfaces.md#provider)
4040

4141
ModelMesh Lite ships with provider connectors for: **OpenAI** (`provider.openai.llm.v1`), **Gemini** (`provider.google.gemini.v1`), **OpenRouter** (`provider.openrouter.gateway.v1`), **Anthropic** (`anthropic.claude.v1`), **Groq** (`provider.groq.api.v1`), **DeepSeek** (`provider.deepseek.api.v1`), **Mistral** (`provider.mistral.api.v1`), **Together AI** (`provider.together.api.v1`), **xAI Grok** (`provider.xai.grok.v1`), **Cohere** (`provider.cohere.nlp.v1`), **Perplexity** (`provider.perplexity.search.v1`), **ElevenLabs** (`provider.elevenlabs.tts.v1`), **Azure Speech** (`provider.azure.tts.v1`), **AssemblyAI** (`provider.assemblyai.stt.v1`), **Tavily** (`provider.tavily.search.v1`), **Serper** (`provider.serper.search.v1`), **Jina** (`provider.jina.search.v1`), **Firecrawl** (`provider.firecrawl.search.v1`), **Ollama** (`ollama.local.v1`), **LM Studio** (`lmstudio.local.v1`), **vLLM** (`vllm.local.v1`), and **LocalAI** (`localai.local.v1`). Providers marked **(Planned)** below are not yet implemented.
4242

4343
### Provider Capability Format
4444

45-
Provider connectors (OpenAI, Anthropic, and others) declare model capabilities using **dot-notation paths** that reference the [capability hierarchy](ModelCapabilities.html). Short-form capability names (`"chat"`, `"tools"`, `"vision"`) are no longer used; capabilities now map directly to tree nodes such as `generation.text-generation.chat-completion`. Features like tool calling, vision, and system prompt support are declared separately in a `features` dict.
45+
Provider connectors (OpenAI, Anthropic, and others) declare model capabilities using **dot-notation paths** that reference the [capability hierarchy](ModelCapabilities.md). Short-form capability names (`"chat"`, `"tools"`, `"vision"`) are no longer used; capabilities now map directly to tree nodes such as `generation.text-generation.chat-completion`. Features like tool calling, vision, and system prompt support are declared separately in a `features` dict.
4646

4747
**Before (short-form, deprecated):**
4848

@@ -69,7 +69,7 @@ The provider-level `capabilities` config follows the same convention. For exampl
6969
7070
### Pool Definition Modes
7171

72-
Pools support three definition modes (see also [SystemConfiguration.md -- Pools](SystemConfiguration.html#pools)):
72+
Pools support three definition modes (see also [SystemConfiguration.md -- Pools](SystemConfiguration.md#pools)):
7373

7474
| Mode | Config Fields | Behaviour |
7575
| --- | --- | --- |
@@ -240,7 +240,7 @@ Non-AI web services can be wrapped as provider connectors using the same interfa
240240
| **BaseProvider** | Node.js | `http`/`https` | Node.js streams | Server-side applications, CLI tools, backend services |
241241
| **BrowserBaseProvider** | Browser, Deno, Bun, Workers | Fetch API | `ReadableStream` | Single-page apps, browser extensions, edge runtimes |
242242

243-
Both classes expose the same provider interface and the same protected hooks for subclassing. See [cdk/BaseClasses](cdk/BaseClasses.html#browserbaseprovider) for details and [guides/BrowserUsage](guides/BrowserUsage.html) for browser setup.
243+
Both classes expose the same provider interface and the same protected hooks for subclassing. See [cdk/BaseClasses](cdk/BaseClasses.md#browserbaseprovider) for details and [guides/BrowserUsage](guides/BrowserUsage.md) for browser setup.
244244

245245
### Runtime Environment Metadata
246246

@@ -290,13 +290,13 @@ transcript = client.audio.transcriptions.create(
290290
)
291291
```
292292

293-
Audio requests are internally bridged to `CompletionRequest`/`CompletionResponse` via the `AudioRequest` and `AudioResponse` types (see [ConnectorInterfaces.md -- Audio](ConnectorInterfaces.html#audio)). The same rotation, failover, and pool logic applies to audio providers.
293+
Audio requests are internally bridged to `CompletionRequest`/`CompletionResponse` via the `AudioRequest` and `AudioResponse` types (see [ConnectorInterfaces.md -- Audio](ConnectorInterfaces.md#audio)). The same rotation, failover, and pool logic applies to audio providers.
294294

295295
---
296296

297297
## Rotation Policies
298298

299-
Interface: [ConnectorInterfaces.md — Rotation Policy](ConnectorInterfaces.html#rotation-policy). Full attributes in [SystemConfiguration.md — Pools](SystemConfiguration.html#pools).
299+
Interface: [ConnectorInterfaces.md — Rotation Policy](ConnectorInterfaces.md#rotation-policy). Full attributes in [SystemConfiguration.md — Pools](SystemConfiguration.md#pools).
300300

301301
| Policy | Description |
302302
| --- | --- |
@@ -313,7 +313,7 @@ Interface: [ConnectorInterfaces.md — Rotation Policy](ConnectorInterfaces.html
313313

314314
## Secret Store Connectors
315315

316-
Interface: [ConnectorInterfaces.md — Secret Store](ConnectorInterfaces.html#secret-store)
316+
Interface: [ConnectorInterfaces.md — Secret Store](ConnectorInterfaces.md#secret-store)
317317

318318
| Store | Description | Free Tier | Docs |
319319
| --- | --- | --- | --- |
@@ -430,7 +430,7 @@ Stores secrets in the browser's localStorage. Supports the full `SecretManagemen
430430

431431
## Storage Connectors
432432

433-
Interface: [ConnectorInterfaces.md — Storage](ConnectorInterfaces.html#storage)
433+
Interface: [ConnectorInterfaces.md — Storage](ConnectorInterfaces.md#storage)
434434

435435
| Connector | Backend | Concurrency | Free Tier | Best For | Docs |
436436
| --- | --- | --- | --- | --- | --- |
@@ -534,7 +534,7 @@ Natively async storage using the browser's IndexedDB API. Stores binary data dir
534534

535535
## Observability Connectors
536536

537-
Interface: [ConnectorInterfaces.md — Observability](ConnectorInterfaces.html#observability)
537+
Interface: [ConnectorInterfaces.md — Observability](ConnectorInterfaces.md#observability)
538538

539539
The observability interface combines four concerns: **events** (state changes), **logging** (request/response data), **statistics** (aggregate metrics), and **tracing** (severity-tagged structured traces). All core components (Router, Pool, Mesh) and CDK base classes (BaseProvider) emit traces through the configured observability connector. If no connector is configured, the `null` connector is used (zero overhead).
540540

@@ -640,7 +640,7 @@ All observability connectors write records with a `"type"` field. The file conne
640640

641641
## Discovery Connectors
642642

643-
Interface: [ConnectorInterfaces.md — Discovery](ConnectorInterfaces.html#discovery)
643+
Interface: [ConnectorInterfaces.md — Discovery](ConnectorInterfaces.md#discovery)
644644

645645
| Connector | Description |
646646
| --- | --- |
@@ -649,4 +649,4 @@ Interface: [ConnectorInterfaces.md — Discovery](ConnectorInterfaces.html#disco
649649

650650
---
651651

652-
See also: [FAQ](guides/FAQ.html) · [Connector Interfaces](ConnectorInterfaces.html) · [CDK Base Classes](cdk/BaseClasses.html) · [System Configuration](SystemConfiguration.html)
652+
See also: [FAQ](guides/FAQ.md) · [Connector Interfaces](ConnectorInterfaces.md) · [CDK Base Classes](cdk/BaseClasses.md) · [System Configuration](SystemConfiguration.md)

0 commit comments

Comments
 (0)