Commit 766fcaf
docs: refresh project landing pages (#5951)
## Summary
- Replace the repository README with a Markdown-first landing page that
prominently highlights pretrained DPA models and the current DeePMD-kit
feature set.
- Route feature-level calls to action to the hosted documentation while
keeping runnable examples in the repository.
- Preserve the theme-aware logo plus the DOI and live citation-count
badges for the three general software publications.
- Refresh the documentation homepage with responsive Sphinx Design
cards, model guidance, data-to-dynamics navigation, and the complete
general software citations.
- Keep the change isolated to `README.md` and `doc/index.rst` to avoid
conflicts with other documentation work.
## Validation
- `ruff check .`
- `ruff format .`
- Repository Markdown and whitespace hooks
- `git diff --check`
- Minimal Sphinx 9.1 HTML build with `sphinx-design`
- Verified all hosted documentation links and citation badge endpoints
referenced by the README return HTTP 200
Fixes #5240
Coding agent: Codex
Codex version: codex-cli 0.144.6
Model: gpt-5.6-sol
Reasoning effort: xhigh
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Rewrote the README with an accessible overview of capabilities, model
families, supported backends, workflows, installation, quick starts,
pretrained models, integrations, licensing, and references.
* Replaced the documentation landing page with structured guidance for
installation, training, deployment, physics features, and recent
developments.
* Improved navigation with card-based sections, clearer guide
categories, project details, generated indices, and search access.
* **References**
* Added citations for the Deep Potential representation and DeePCG
coarse-grained model.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Signed-off-by: Jinzhe Zeng <njzjz@qq.com>
Co-authored-by: njzjz-bot <njzjz.bot@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: njzjz-bot (driven by OpenClaw (model: custom-chat-jinzhezeng-group/gpt-5.6-terra))[bot] <48687836+njzjz-bot@users.noreply.github.com>
Co-authored-by: Duo <50307526+iProzd@users.noreply.github.com>
Co-authored-by: njzjz-bot <njzjz-bot@users.noreply.github.com>1 parent 5ec909c commit 766fcaf
10 files changed
Lines changed: 723 additions & 123 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
86 | 86 | | |
87 | 87 | | |
88 | 88 | | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
89 | 105 | | |
90 | 106 | | |
91 | 107 | | |
| |||
120 | 136 | | |
121 | 137 | | |
122 | 138 | | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
123 | 151 | | |
124 | 152 | | |
125 | 153 | | |
| |||
196 | 224 | | |
197 | 225 | | |
198 | 226 | | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
199 | 256 | | |
200 | 257 | | |
201 | 258 | | |
| |||
262 | 319 | | |
263 | 320 | | |
264 | 321 | | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
265 | 334 | | |
266 | 335 | | |
267 | 336 | | |
| |||
Large diffs are not rendered by default.
Loading
Loading
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
18 | 36 | | |
19 | 37 | | |
20 | 38 | | |
| |||
57 | 75 | | |
58 | 76 | | |
59 | 77 | | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
60 | 96 | | |
61 | 97 | | |
62 | 98 | | |
| |||
85 | 121 | | |
86 | 122 | | |
87 | 123 | | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
88 | 133 | | |
89 | 134 | | |
90 | 135 | | |
| |||
0 commit comments