Skip to content

Commit 8582ba4

Browse files
committed
docs: add internal links
1 parent 9eec577 commit 8582ba4

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The test suite compliance dashboard is comprised of two parts:
1616
If you are an array library maintainer wanting to report Array API test suite results, you need to do two things:
1717

1818
1. Set up a public endpoint from which your test suite results can be regularly retrieved. This can be a GitHub workflow artifact, a public URL, or some other supported endpoint mechanism.
19-
2. Register your library's public endpoint(s) with this repository. See **Registration** below.
19+
2. Register your library's public endpoint(s) with this repository. See [**Registration**](#registration) below.
2020

2121
For array libraries already using GitHub workflows for running their test suites (including against the Array API test suite), see the [demonstration](https://github.com/data-apis/array-api-tests-compliance-data/blob/main/.github/workflows/demo.yml) GitHub workflow for how to run the test suite and generate a valid test suite report JSON.
2222

@@ -25,6 +25,8 @@ For array libraries already using GitHub workflows for running their test suites
2525
2626
* * *
2727

28+
<a name="registration"></a>
29+
2830
## Registration
2931

3032
If you are the maintainer of an array library adopting the Array API standard and would like to submit test suite results, you're in the right place!
@@ -74,7 +76,7 @@ To add your library, please do the following:
7476

7577
4. Open a PR against this repository which adds the registration entry. Once merged, automated workflows will begin monitoring the registration endpoint(s).
7678

77-
5. Set up your library to begin publishing test suite results. See below concerning **Test Suite Artifacts**.
79+
5. Set up your library to begin publishing test suite results. See below concerning [**Test Suite Artifacts**](#test-suite-artifacts).
7880

7981
### Examples
8082

@@ -157,7 +159,7 @@ Once the raw report is generated, you need to augment the generated JSON with ad
157159

158160
- **schema**: report schema version (e.g., `v1`).
159161

160-
- **name**: array library name. This **must** match the registration `report_name`, as discussed above.
162+
- **name**: array library name. This **must** match the registration `report_name`, as discussed above for registering an array library (see [**Registration**](#registration)).
161163

162164
- **version**: array library version. This is the version of your library against which the test suite ran.
163165

0 commit comments

Comments
 (0)