Skip to content

Commit aefe63e

Browse files
deeenesclaude
andcommitted
Restructure and populate documentation
Replace template placeholder docs with real content: - Home page with feature overview and quick example - Installation guide (pip, source, uv, optional deps) - Quickstart with examples for all endpoints and features - API reference via mkdocstrings (all public classes/functions) - Vignettes placeholder for future notebooks - Simplified About page with citation Removes unused community, learn, explanation, and project philosophy sections from the template. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3208b07 commit aefe63e

19 files changed

Lines changed: 363 additions & 535 deletions

File tree

docs/about.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
11
# About
22

3-
This project was created by OmniPath Team.
3+
omnipath-client is developed by the
4+
[Saez-Rodriguez group](https://saezlab.org/) at Heidelberg University Hospital.
5+
6+
## Links
7+
8+
- **Source code**: [github.com/saezlab/omnipath-client](https://github.com/saezlab/omnipath-client)
9+
- **OmniPath**: [omnipathdb.org](https://omnipathdb.org/)
10+
- **API**: [dev.omnipathdb.org](https://dev.omnipathdb.org/)
11+
- **Issues**: [github.com/saezlab/omnipath-client/issues](https://github.com/saezlab/omnipath-client/issues)
12+
13+
## License
14+
15+
BSD-3-Clause. See the
16+
[LICENSE](https://github.com/saezlab/omnipath-client/blob/master/LICENSE)
17+
file for details.
18+
19+
## Citation
20+
21+
If you use OmniPath data in your research, please cite:
22+
23+
> Turei D, Valdeolivas A, Gul L, Palacio-Escat N, Klein M, Ivanova O,
24+
> Olbei M, Gabor A, Theis F, Korcsmaros T, Saez-Rodriguez J. (2021)
25+
> Integrated intra- and intercellular signaling knowledge for multicellular
26+
> omics analysis. *Molecular Systems Biology* 17:e9923.
27+
> [doi:10.15252/msb.20209923](https://doi.org/10.15252/msb.20209923)

docs/community/contribute-codebase.md

Lines changed: 0 additions & 333 deletions
This file was deleted.

docs/community/contribute-docs.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
 (0)