Skip to content

Commit 8ba1272

Browse files
mruedamrueda
committed
Update docs
1 parent 29074f6 commit 8ba1272

131 files changed

Lines changed: 29 additions & 27347 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Changes‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Revision history for Perl distribution Pheno-Ranker
22

33
1.09 2025-0X-0X:00:00Z (Manuel Rueda <mrueda@cpan.org>)
44

5-
- Foo
5+
- Migrated project documentation from MkDocs to Docusaurus
66

77
1.08 2025-05-01:00:00Z (Manuel Rueda <mrueda@cpan.org>)
88

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<a href="https://github.com/cnag-biomedical-informatics/pheno-ranker"><img src="https://raw.githubusercontent.com/cnag-biomedical-informatics/pheno-ranker/main/docs/img/PR-logo.png" width="400" alt="Pheno-Ranker"></a>
2+
<a href="https://github.com/cnag-biomedical-informatics/pheno-ranker"><img src="https://raw.githubusercontent.com/cnag-biomedical-informatics/pheno-ranker/main/docs-site/static/img/PR-logo.png" width="400" alt="Pheno-Ranker"></a>
33
</p>
44
<p align="center">
55
<em>Pheno-Ranker: a command-line toolkit for comparison of phenotypic data stored in GA4GH standards and beyond</em>

‎README.md.template‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<a href="https://github.com/cnag-biomedical-informatics/pheno-ranker"><img src="https://raw.githubusercontent.com/cnag-biomedical-informatics/pheno-ranker/main/docs/img/PR-logo.png" width="400" alt="Pheno-Ranker"></a>
2+
<a href="https://github.com/cnag-biomedical-informatics/pheno-ranker"><img src="https://raw.githubusercontent.com/cnag-biomedical-informatics/pheno-ranker/main/docs-site/static/img/PR-logo.png" width="400" alt="Pheno-Ranker"></a>
33
</p>
44
<p align="center">
55
<em>Pheno-Ranker: a command-line toolkit for comparison of phenotypic data stored in GA4GH standards and beyond</em>

‎docker/Dockerfile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ RUN git clone https://github.com/CNAG-Biomedical-Informatics/pheno-ranker.git
3838
# Remove Git metadata and CI configs to shrink image and avoid shipping them
3939
RUN rm -rf pheno-ranker/.git pheno-ranker/.github pheno-ranker/.gitattributes pheno-ranker/.gitignore
4040

41-
# Remove docs
42-
RUN rm -rf pheno-ranker/docs/ pheno-ranker/mkdocs.yml
41+
# Remove documentation site assets from the runtime image
42+
RUN rm -rf pheno-ranker/docs-site/
4343

4444
# Install Perl and Python dependencies
4545
WORKDIR /usr/share/pheno-ranker

‎docs-site/docs/about.mdx‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22
title: "About"
33
slug: "/about"
44
---
5-
6-
<!--
7-
Generated from legacy MkDocs content.
8-
Do not edit this file directly; edit docs/*.md and run:
9-
npm --prefix docs-site run prebuild
10-
-->
11-
125
**Pheno-Ranker** is developed at [CNAG](https://cnag.eu), Barcelona, Spain, with contributions from collaborators who helped shape the command-line interface, web interface, utilities, and documentation.
136

147
<div className="about-hero">
@@ -50,7 +43,7 @@ Do not edit this file directly; edit docs/*.md and run:
5043
<article className="about-card">
5144
<span className="about-kicker">CNAG</span>
5245
<h3>Data Platforms</h3>
53-
<p><a href="https://github.com/dpiscia">Davide Piscia</a> and his <a href="https://www.cnag.eu/teams/bioinformatics-unit/data-platforms-and-tools-development">team</a>.</p>
46+
<p><a href="https://github.com/dpiscia">Davide Piscia</a> and his <a href="https://www.cnag.eu/teams/bioinformatics-unit/data-platforms-and-tools-development">team</a>. The Pheno-Ranker logo was created by <a href="https://www.cnag.eu/sofia-chaves">Sofia Chaves</a> from Davide Piscia's team.</p>
5447
</article>
5548
<article className="about-card">
5649
<span className="about-kicker">External</span>

‎docs-site/docs/algorithm.mdx‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22
title: "`Pheno-Ranker` algorithm"
33
slug: "/algorithm"
44
---
5-
6-
<!--
7-
Generated from legacy MkDocs content.
8-
Do not edit this file directly; edit docs/*.md and run:
9-
npm --prefix docs-site run prebuild
10-
-->
11-
125
# `Pheno-Ranker` algorithm
136

147
```mermaid

‎docs-site/docs/bff-pxf-plot.mdx‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,10 @@ title: "BFF-PXF-PLOT"
33
slug: "/bff-pxf-plot"
44
---
55

6+
67
import Tabs from '@theme/Tabs';
78
import TabItem from '@theme/TabItem';
89

9-
<!--
10-
Generated from legacy MkDocs content.
11-
Do not edit this file directly; edit docs/*.md and run:
12-
npm --prefix docs-site run prebuild
13-
-->
14-
1510
# BFF-PXF-PLOT
1611

1712
<Tabs>

‎docs-site/docs/bff-pxf-simulator.mdx‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,10 @@ title: "BFF-PXF-SIMULATOR"
33
slug: "/bff-pxf-simulator"
44
---
55

6+
67
import Tabs from '@theme/Tabs';
78
import TabItem from '@theme/TabItem';
89

9-
<!--
10-
Generated from legacy MkDocs content.
11-
Do not edit this file directly; edit docs/*.md and run:
12-
npm --prefix docs-site run prebuild
13-
-->
14-
1510
# BFF-PXF-SIMULATOR
1611

1712
<Tabs>

‎docs-site/docs/bff.mdx‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,10 @@ title: "Beacon v2 Models"
33
slug: "/bff"
44
---
55

6+
67
import Tabs from '@theme/Tabs';
78
import TabItem from '@theme/TabItem';
89

9-
<!--
10-
Generated from legacy MkDocs content.
11-
Do not edit this file directly; edit docs/*.md and run:
12-
npm --prefix docs-site run prebuild
13-
-->
14-
1510
**BFF** stands for **B**eacon **F**riendly **F**ormat. The [BFF](https://b2ri-documentation.readthedocs.io/en/latest/data-ingestion) is a data exchange format composed of 7 `JSON` files. These files correspond to the 7 entities of the [Beacon v2 Models](https://docs.genomebeacons.org/models).
1611

1712
<div className="phenoFormatSummary" aria-label="At a glance">

‎docs-site/docs/citation.mdx‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22
title: "Citation for Pheno-Ranker"
33
slug: "/citation"
44
---
5-
6-
<!--
7-
Generated from legacy MkDocs content.
8-
Do not edit this file directly; edit docs/*.md and run:
9-
npm --prefix docs-site run prebuild
10-
-->
11-
125
# Citation for Pheno-Ranker
136

147
:::info[Citation]

0 commit comments

Comments
 (0)