Skip to content

Commit

Permalink
Check URLs (#17)
Browse files Browse the repository at this point in the history
* Create check-urls.yml

* Fix broken links
  • Loading branch information
nwlandry authored Sep 27, 2024
1 parent 7aefda6 commit 66c91a0
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/check-urls.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Check URLs

on: [push]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: urls-checker
uses: urlstechie/urlchecker-action@master
with:
# A comma-separated list of file types to cover in the URL checks
file_types: .md,.py,.ipynb

# Choose whether to include file with no URLs in the prints.
print_all: false

# The timeout seconds to provide to requests, defaults to 5 seconds
timeout: 5

# How many times to retry a failed request (each is logged, defaults to 1)
retry_count: 3

# choose if the force pass or not
force_pass : false
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
## The Hypergraph Interchange Format (HIF) standard
(Work-in-progress)

Hypergraph Exchange Format (HIF) is a forthcoming standard for higher-order network data to facilitate seamless data exchange between existing higher-order network libraries.
Hypergraph Interchange Format (HIF) is a forthcoming standard for higher-order network data to facilitate seamless data exchange between existing higher-order network libraries.

### Table of contents for this folder

This repository is organized into the following folders:
* `examples`: This folder contains examples of higher-order datasets in the HIF standard. For details of its contents, see the [README](/examples/EXAMPLES.md).
* `requirements`: This folder contains a list of all dependencies used in this project.
* `schemas`: This folder contains all schemas used for specifying the HIF standard. For details of what has changed with each version, see the [CHANGELOG](/schemas/SCHEMAS.md).
* `schemas`: This folder contains all schemas used for specifying the HIF standard. For details of what has changed with each version, see the [CHANGELOG](/schemas/CHANGLEOG.md).
* `src`: This folder contains addition functionality for checking against the HIF specification.
* `tests`: This folder contains all of the unit tests used for validating that the schema is correct.
* `tutorials`: This folder contains tutorials detailing how each library uses the HIF standard and how the HIF standard allows seamless integration between libraries. For details of its contents, see the [README](/examples/TUTORIALS.md).
* `tutorials`: This folder contains tutorials detailing how each library uses the HIF standard and how the HIF standard allows seamless integration between libraries. For details of its contents, see the [README](/tutorials/TUTORIALS.md).

Initial assumptions about the core of the HIF data format:
```
Expand Down

0 comments on commit 66c91a0

Please sign in to comment.