Skip to content

Commit 04365f8

Browse files
author
mlevesquedion
authored
Fix broken links (#2082)
Most of these links are only broken when rendered out of tree, e.g. on the OpenXLA website: https://openxla.org/stablehlo. For example, the "More Examples" links lead to e.g. https://openxla.org/stablehlo/tests/interpret/add.mlir, which is 404. For links under `docs/` it is possible to use relative paths. Also, add labels to images used in spec. This will materialize as the "alt" text, which is used by screen readers.
1 parent a8f44d0 commit 04365f8

File tree

3 files changed

+100
-100
lines changed

3 files changed

+100
-100
lines changed

docs/compatibility.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
StableHLO is a backward compatible ML compute opset inspired by HLO/MHLO.
44
This document explains the kind and the extent of the compatibility guarantees
55
that StableHLO provides, based on the process established in
6-
[the compatibility RFC](../rfcs/20220912-compatibility.md).
6+
[the compatibility RFC](https://github.com/openxla/stablehlo/tree/main/rfcs/20220912-compatibility.md).
77

88
## Versions
99

@@ -126,8 +126,8 @@ for roundtrip examples of using the Python Serialization APIs.
126126

127127
## Tests
128128

129-
We have a compatibility suite in [stablehlo/tests/vhlo](../stablehlo/tests/vhlo)
130-
that involves [a comprehensive compendium of StableHLO ops](../stablehlo/tests/vhlo/stablehlo_legalize_to_vhlo.mlir)
129+
We have a compatibility suite in [stablehlo/tests/vhlo](https://github.com/openxla/stablehlo/tree/main/stablehlo/tests/vhlo)
130+
that involves [a comprehensive compendium of StableHLO ops](https://github.com/openxla/stablehlo/tree/main/stablehlo/tests/vhlo/stablehlo_legalize_to_vhlo.mlir)
131131
serialized for all supported StableHLO versions. For every pull request, we are
132132
testing both backward and forward compatibility - i.e. that the suite can be
133133
deserialized targeting HEAD (backward compatibility), that the compendium

docs/reference_checklist.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ on those fronts alongside the interpreter implementation.
6363
an open issue reflecting that discrepancy.
6464
1. In [interpreter tests](https://github.com/openxla/stablehlo/tree/main/stablehlo/tests/interpret):
6565
1. Add a file called `<op_mnemonic>.mlir`.
66-
1. Write tests following the [testing guidelines](https://github.com/openxla/stablehlo/blob/main/docs/reference.md#testing-guidelines).
66+
1. Write tests following the [testing guidelines](reference.md#testing-guidelines).
6767
1. In the [testdata directory](https://github.com/openxla/stablehlo/tree/main/stablehlo/testdata):
6868
1. Run any disabled tests that are covered by the newly added operation.
6969
1. If the tests pass, enable them by converting `RUN-DISABLED` to `RUN`.
@@ -94,13 +94,13 @@ on those fronts alongside the interpreter implementation.
9494
in this file, following the same naming guidelines noted above.
9595
1. Move any shape inference tests from the [ops_stablehlo.mlir](https://github.com/openxla/stablehlo/blob/main/stablehlo/tests/ops_stablehlo.mlir)
9696
file into this file.
97-
1. In [spec.md](link):
97+
1. In [spec.md](spec.md):
9898
1. Add a link to `stablehlo/tests/interpret/<op_mnemonic>.mlir`
9999
to the "Examples" section
100-
(e.g. [More Examples](https://github.com/openxla/stablehlo/blob/main/docs/spec.md#add)).
100+
(e.g. [More Examples](spec.md#add)).
101101
1. Make sure the spec only has 1 example.
102-
1. Make sure the spec example follows the [testing guidelines](https://github.com/openxla/stablehlo/blob/main/docs/reference.md#testing-guidelines).
102+
1. Make sure the spec example follows the [testing guidelines](reference.md#testing-guidelines).
103103
1. Make sure the spec example test is interpretable.
104104
1. Make sure the spec example is the same as what is in the ODS.
105-
1. In [status.md](https://github.com/openxla/stablehlo/blob/main/docs/status.md):
105+
1. In [status.md](status.md):
106106
1. Update the "Interpreter" column to `yes`.

0 commit comments

Comments
 (0)