Skip to content

Commit

Permalink
Updating the readthedocs links
Browse files Browse the repository at this point in the history
  • Loading branch information
IFenton committed Aug 1, 2024
1 parent 13a5086 commit a6614fd
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 5 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,11 @@ For larger features, substantial changes, or anything where you would like early
🎁 Contributing to the Scivision catalog
---

There are three ways in which you can contribute to the Scivision catalog: models, data, projects.

.. _contributing-a-model:

### Contributing a model
## Contributing a model

#### Preparing a model for inclusion in the catalog

Expand All @@ -114,7 +116,7 @@ After you are done, create a pull request with the changes. A Scivision maintain

.. _contributing-a-datasource:

### Contributing a datasource
## Contributing a datasource

#### Preparing a dataset for inclusion in the catalog

Expand Down Expand Up @@ -142,7 +144,7 @@ After you are done, create a pull request to the original repo with the changes.

.. _contributing-a-project:

### Contributing a project
## Contributing a project

Once you have submitted your model / datasource for inclusion in the catalog, you might want to also consider submitting a project to provide some more details about how they have been used in your research.

Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ In brief, the notebook demonstrates the following:
📖 Catalog of models and datasets
------------------------------

The models and datasets you find when searching the "default" Scivision catalog (that which comes with the package) are loaded from external sources via metadata included in the [GitHub repository](https://github.com/alan-turing-institute/scivision/tree/main/scivision/catalog/data).
The models and datasets you find when searching the "default" Scivision catalog (that which comes with the package) are loaded from external sources via metadata included in the [GitHub repository](https://github.com/alan-turing-institute/scivision/tree/main/src/scivision/catalog/data).

To understand how these external sources are configured for compatibility with Scivision, consult the following sections of this documentation:

Expand Down

0 comments on commit a6614fd

Please sign in to comment.