google-deepmind / google-deepmind/torax

Suggestion: a structured docs site built from your README + readthedocs content

Open
#2,349 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
721
Forks
145
Avg merge
2d 14h
Merged PRs (30d)
49

Description

Really impressive to see a differentiable tokamak transport simulator built natively in JAX, with auto-diff PDE solvers and QuaLiKiz surrogate coupling out of the box. That's a serious engineering bet, and the 700+ stars and steady commit cadence show it is paying off.

One thing stood out reading through the repo: the README carries the entire onboarding story (install, config flags, tutorials, citation) in a single 9,400-character file, with the fuller docs living separately on readthedocs. That split makes both harder to navigate for someone evaluating TORAX for the first time.

We put together a working site from your existing docs to show what that looks like restructured: https://google-deepmind.docsbook.io/torax

It's SEO/GEO-optimized (so it's citable by Perplexity/ChatGPT Search/Google AI Overviews, not just indexed), has an AI chat trained on your docs so users can ask "how do I run my first simulation" instead of grepping the README, and search/breadcrumbs/edit-on-GitHub wired in.

This is a demo we built from your public repo and readthedocs content, not official TORAX documentation, just meant to show the shape of it. If it's useful, we'd be glad to hand the workspace over to your team — no strings attached either way.

Best,
Dan

Contributor guide

Open the contributing guide

Research direction

Start by comparing the repository README with the fuller Read the Docs content and reviewing the linked demo site. The issue does not identify files, tests, or a specific documentation change; a contributor would first need an agreed scope, ownership, and acceptance criteria before implementation could begin.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.