Skip to content

Remove doc dev section from README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maxscheurer merged 1 commit into from
Apr 10, 2026
Merged

Remove doc dev section from README #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,6 @@ conda activate mdfactory
pip install -e .[dev]
```

## Documentation

We ship an auto-generated documentation site under `docs/` powered by Next.js and Fumadocs. It combines hand-written guides with API pages produced from the Python package using `fumadocs-python`.

1. Install the tooling:
```bash
cd docs
bun install
python3.11 -m pip install -e ..
python3.11 -m pip install ./node_modules/fumadocs-python
```
2. Generate docs + run the dev server (this command automatically rebuilds the API docs on every run):
```bash
bun run dev
```

Use `bun run docs:generate` if you only need to refresh the MDX output without running Next.js, and `bun run build` to produce a production bundle in `docs/out` (set `GITHUB_PAGES=true` when you want to simulate the GitHub Pages base path locally).

The docs are published from `docs/out` via the GitHub Actions workflow at `.github/workflows/docs.yml`.

## Quick Start

Expand Down
Loading