# How to Access OpenMed Documentation: 3 Ways to View Guides and API References

> Easily access OpenMed documentation through three simple methods: online at openmed.life/docs, within the GitHub repository, or locally after cloning. Find guides and API references effortlessly.

- Repository: [Maziyar Panahi/openmed](https://github.com/maziyarpanahi/openmed)
- Tags: api-reference
- Published: 2026-06-13

---

**OpenMed documentation is available online at openmed.life/docs, in the GitHub repository under the `docs/` folder, or locally after cloning the repo.**

The **maziyarpanahi/openmed** repository provides comprehensive guides for medical NLP tasks. Whether you need quick API references or detailed setup instructions, you can access OpenMed documentation through multiple channels that sync automatically with each release.

## Online Documentation Portal

The fastest way to access OpenMed documentation is through the public site at **`openmed.life/docs`**. This hosted portal provides a searchable, versioned interface with all guides including **Getting Started**, **REST Service**, **Zero-Shot NER**, and **profiling** documentation.

The website serves as the rendered view of the **single source of truth** located in the repository. Content updates automatically via **CI pipeline** integration that pulls the latest `master` branch on each release. For version-specific documentation, replace `master` with a tag name (e.g., `v1.5.5`) in any GitHub URL.

The site is built with **Material for MkDocs**, providing features like instant search (`Cmd/Ctrl+K`) and copy buttons on all code blocks.

## GitHub Source Documentation

Every guide lives as raw **Markdown** in the repository's **`docs/`** folder. Browsing the source directly lets you view the exact syntax and internal links referenced by the web build.

Key documentation files include:

- **[`docs/getting-started.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/getting-started.md)** – Environment bootstrap and first-run instructions
- **[`docs/zero-shot-ner.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/zero-shot-ner.md)** – **GLiNER** zero-shot NER toolkit installation and usage
- **[`docs/rest-service.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/rest-service.md)** – **FastAPI** service deployment and endpoint specifications
- **[`docs/profiling.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/profiling.md)** – Performance utilities and optimization tips
- **[`docs/model-registry.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/model-registry.md)** – Model catalog and loading conventions

View these files at `github.com/maziyarpanahi/openmed/tree/master/docs`.

## Local Documentation Access

After **cloning** the repository, you can read documentation offline using any Markdown viewer or text editor.

```bash
git clone https://github.com/maziyarpanahi/openmed.git
cd openmed
code docs/getting-started.md

```

The **[`README.md`](https://github.com/maziyarpanahi/openmed/blob/main/README.md)** at the repository root contains quick-start examples and links to the full documentation set. Opening files locally is useful when working on air-gapped systems or when you need to reference documentation while modifying the source code.

## Programmatic Access to Documentation

For **automation** or embedding in **Jupyter notebooks**, you can fetch documentation programmatically.

Open the hosted documentation or a local file using Python's `webbrowser` module:

```python
import webbrowser
from pathlib import Path

# Open the online portal

webbrowser.open("https://openmed.life/docs")

# Or open a local markdown file

local_path = Path("docs/rest-service.md")
webbrowser.open(local_path.as_uri())

```

Fetch raw Markdown content directly from GitHub for parsing or display:

```python
import requests

raw_url = (
    "https://raw.githubusercontent.com/maziyarpanahi/openmed/master/"
    "docs/zero-shot-ner.md"
)

response = requests.get(raw_url, timeout=10)
response.raise_for_status()
markdown_content = response.text

```

## Key Documentation Files and Source Paths

According to the **maziyarpanahi/openmed** source code, the complete documentation set includes the following files:

| File | Purpose |
|------|---------|
| [`README.md`](https://github.com/maziyarpanahi/openmed/blob/main/README.md) | Central overview, quick-start examples, and badge links |
| [`docs/getting-started.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/getting-started.md) | Step-by-step environment setup and first-run |
| [`docs/zero-shot-ner.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/zero-shot-ner.md) | Zero-shot NER toolkit guide |
| [`docs/rest-service.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/rest-service.md) | REST API specifications and deployment |
| [`docs/profiling.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/profiling.md) | Performance profiling utilities |
| [`docs/model-registry.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/model-registry.md) | Model management and loading conventions |
| [`openmed/__init__.py`](https://github.com/maziyarpanahi/openmed/blob/main/openmed/__init__.py) | Package entry point exposing `analyze_text` and `extract_pii` |
| [`openmed/core/config.py`](https://github.com/maziyarpanahi/openmed/blob/main/openmed/core/config.py) | Configuration schema referenced throughout guides |

These paths represent the authoritative source for all documentation content.

## Summary

- **Online portal**: Visit `openmed.life/docs` for the searchable, versioned documentation interface
- **GitHub source**: Browse the `docs/` folder for raw Markdown files that serve as the single source of truth
- **Local access**: Clone the repository and open `.md` files in any editor after running `git clone https://github.com/maziyarpanahi/openmed.git`
- **Programmatic access**: Use Python's `webbrowser` or `requests` modules to open or fetch documentation content
- **Version control**: Access specific releases by replacing `master` with version tags (e.g., `v1.5.5`) in GitHub URLs
- **Key files**: Reference [`docs/rest-service.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/rest-service.md) for API details and [`openmed/__init__.py`](https://github.com/maziyarpanahi/openmed/blob/main/openmed/__init__.py) for package interface documentation

## Frequently Asked Questions

### Where is the official OpenMed documentation website?

The official documentation is hosted at **`openmed.life/docs`**. This site provides a searchable interface with all guides including Getting Started, REST Service, and Zero-Shot NER documentation. The content is automatically updated via CI pipeline integration with the GitHub repository.

### Can I read OpenMed documentation offline?

Yes. After cloning the repository with `git clone https://github.com/maziyarpanahi/openmed.git`, you can open any file in the `docs/` folder using a Markdown viewer or text editor. The [`README.md`](https://github.com/maziyarpanahi/openmed/blob/main/README.md) file also contains essential quick-start information that functions without an internet connection.

### How do I access documentation for a specific version of OpenMed?

To view version-specific documentation, navigate to the GitHub repository and replace `master` with the desired tag name (such as `v1.5.5`) in the URL. The online documentation at `openmed.life/docs` typically reflects the latest stable release, while historical versions remain accessible through tagged GitHub URLs.

### Which file contains the REST API documentation?

The REST Service documentation is located at **[`docs/rest-service.md`](https://github.com/maziyarpanahi/openmed/blob/main/docs/rest-service.md)** in the repository. This file contains FastAPI deployment instructions and detailed endpoint specifications. You can view it online at `openmed.life/docs/rest-service` or access the raw Markdown source on GitHub.