Skip to content

Commit 3d760b3

Browse files
committed
Improve documentation navigation
1 parent af5c9c3 commit 3d760b3

2 files changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,14 +117,20 @@ List<WebLink> authors = view.author();
117117

118118
### More examples
119119

120-
Additional, self-contained examples are available in the `examples/` directory, including:
120+
Compass comes with example-driven documentation that explains common
121+
FAIR Signposting validation scenarios step by step:
122+
123+
- FAIR Signposting **Level 1** validation:
124+
[`doc/level1-basic-validation.md`](doc/level1-basic-validation.md)
125+
126+
- FAIR Signposting **Level 2 discovery** using Link Sets (RFC 9264)
121127

122-
- FAIR Signposting **Level 1** validation scenarios
123-
- **Level 2 discovery** using Link Sets (RFC 9264)
124128
- Handling **multiple Link Sets** with different aggregation strategies
129+
125130
- Validation of **incomplete or non-compliant** Signposting data
126131

127-
Each example is designed to be minimal, runnable, and focused on a single concept.
132+
Each document is self-contained and focuses on a single concept,
133+
using real-world HTTP Link header examples and minimal Java snippets.
128134

129135
---
130136

File renamed without changes.

0 commit comments

Comments
 (0)