Skip to content

Commit 4361965

Browse files
slugb0tslugb0t
authored
Merge pull request #26 from fairdataihub/readme-feature
refactor: ♻️ update features page and resources
2 parents fa5bb61 + 936e577 commit 4361965

File tree

3 files changed

+26
-13
lines changed

3 files changed

+26
-13
lines changed

‎docs/.vitepress/config.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ function portalSidebarGuide() {
178178
{ text: 'Metadata', link: '/docs/metadata.md' },
179179
{ text: 'CWL Validation', link: '/docs/cwl.md' },
180180
{ text: 'Software Archival', link: '/docs/archive.md' },
181-
{ text: 'README', link: '/docs/readme.md' },
181+
{ text: 'README.md', link: '/docs/readme.md' },
182182
{ text: 'CONTRIBUTING.md', link: '/docs/contributing.md' },
183183
{ text: 'CODE_OF_CONDUCT.md', link: '/docs/code-of-conduct.md' },
184184
],
@@ -188,7 +188,7 @@ function portalSidebarGuide() {
188188
collapsible: true,
189189
items: [
190190
{ text: 'Upcoming Features', link: '/docs/upcoming.md' },
191-
{ text: 'Contributing', link: '/docs/contributing.md' },
191+
{ text: 'Contributing', link: '/docs/contributing-to-codefair.md' },
192192
],
193193
},
194194
];

‎docs/docs/contributing-to-codefair.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
lang: en-US
3+
title: Contributing
4+
description: Contributing
5+
head:
6+
- - meta
7+
- name: og:image
8+
content: https://kalai.fairdataihub.org/api/generate?title=Codefair%20Documentation&description=Contributing&app=codefair&org=fairdataihub
9+
---
10+
11+
# :clap: Contributing
12+
13+
We would love your contribution! Please see our [Developers documentation](https://docs.codefair.io/dev/intro.html) for contributing.

‎docs/docs/features.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ The table below lists all the current and upcoming features of Codefair. It also
1414

1515
Specifically the `Research discipline` column indicates the research discipline of the software for which this feature is suitable (e.g., biomedical, mathematics, etc.). Similarly, the `Coding language` column indicates the coding language of the research software for which this feature is suitable (e.g., Python, R, etc.). The `Software format` column indicates the format of the research software for which this feature is suitable (e.g., desktop software, command line interface, etc.). Finally, the `Software application` indicates the application of the research software for which the feature is suitable (e.g., computational model, AI-ML model, etc.).
1616

17-
| Feature | Anticipated release date | Research discipline | Coding language | Software format | Software application |
18-
| :----------------------------------------------------------------------- | :----------------------- | :------------------ | :----------------------------- | :--------------------- | :------------------- |
19-
| [License](./license.md) | Released | All | All | All | All |
20-
| [Metadata](./metadata.md) | Released | All | All | All | All |
21-
| [CWL validation](./cwl.md) | August 2024 | All | Common Workflow Language (CWL) | Command line interface | All |
22-
| [Quick release and archiving](./upcoming.md#quick-release-and-archiving) | October 2024 | All | All | All | All |
23-
| [README](./upcoming.md#quick-release-and-archiving) | May 2025 | All | All | All | All |
24-
| [CONTRIBUTING](./upcoming.md#quick-release-and-archiving) | May 2025 | All | All | All | All |
25-
| [CODE_OF_CONDUCT](./upcoming.md#quick-release-and-archiving) | May 2025 | All | All | All | All |
26-
| [Code formatter](./upcoming.md#code-formatter) | TBD | All | Python, Javascript, Typescript | All | All |
27-
| [Automated CHANGELOG update](./upcoming.md#automated-changelog-update) | TBD | All | All | All | All |
17+
| Feature | Anticipated release date | Research discipline | Coding language | Software format | Software application |
18+
| :--------------------------------------------------------------------- | :----------------------- | :------------------ | :----------------------------- | :--------------------- | :------------------- |
19+
| [License](./license.md) | Released | All | All | All | All |
20+
| [Metadata](./metadata.md) | Released | All | All | All | All |
21+
| [CWL validation](./cwl.md) | August 2024 | All | Common Workflow Language (CWL) | Command line interface | All |
22+
| [Quick release and archiving](./archive) | October 2024 | All | All | All | All |
23+
| [README](./readme.md) | May 2025 | All | All | All | All |
24+
| [CONTRIBUTING](./contributing.md) | May 2025 | All | All | All | All |
25+
| [CODE_OF_CONDUCT](./code-of-conduct.md) | May 2025 | All | All | All | All |
26+
| [Code formatter](./upcoming.md#code-formatter) | TBD | All | Python, Javascript, Typescript | All | All |
27+
| [Automated CHANGELOG update](./upcoming.md#automated-changelog-update) | TBD | All | All | All | All |

0 commit comments

Comments
 (0)