Skip to content

Commit acc7d90

Browse files
chore(docs): fix formatting
1 parent 121c958 commit acc7d90

3 files changed

Lines changed: 9 additions & 8 deletions

File tree

custom-words.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Kincaid
1616
llm
1717
llms
1818
opid
19+
parsability
1920
parsable
2021
PKCE
2122
privatetoken

docs/publishing/overview-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Descriptive richness, intent phrasing, workflow context, and registry signals. C
5353
The final AI-Readiness score maps to one of five levels:
5454

5555
| Level | Score Range | Name | Meaning |
56-
|-------|-------------|------|---------|
56+
| ----- | ----------- | ---- | ------- |
5757
| **Level 0** | < 40 | **Not Ready** | Fundamentally unsuitable for AI or agents |
5858
| **Level 1** | 40–60 | **Foundational** | Developer-ready, partially AI-usable |
5959
| **Level 2** | 60–75 | **AI-Aware** | Semantically interpretable, safe for guided use |

docs/publishing/scoring-engine-status-template.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This page tracks the implementation status of signals in the Jentic API AI-Readi
88
## Implementation Status Key
99

1010
| Symbol | Status | Description |
11-
|--------|--------|-------------|
11+
| ------ | ------ | ----------- |
1212
|| Implemented | Signal is fully implemented and tested |
1313
| 🚧 | In Progress | Signal implementation is underway |
1414
| 📋 | Planned | Signal is specified but not yet implemented |
@@ -19,7 +19,7 @@ This page tracks the implementation status of signals in the Jentic API AI-Readi
1919
## Foundational Compliance (FC)
2020

2121
| Signal | Status | Notes |
22-
|--------|--------|-------|
22+
| ------ | ------ | ----- |
2323
| `spec_validity` || Binary check for valid OpenAPI |
2424
| `resolution_completeness` || $ref resolution tracking |
2525
| `lint_results` || Spectral/Redocly integration |
@@ -28,7 +28,7 @@ This page tracks the implementation status of signals in the Jentic API AI-Readi
2828
## Developer Experience & Tooling Compatibility (DXJ)
2929

3030
| Signal | Status | Notes |
31-
|--------|--------|-------|
31+
| ------ | ------ | ----- |
3232
| `example_density` || Coverage across eligible locations |
3333
| `example_validity` || Schema conformance checking |
3434
| `doc_clarity` | 📋 | Readability scoring |
@@ -38,7 +38,7 @@ This page tracks the implementation status of signals in the Jentic API AI-Readi
3838
## AI-Readiness & Agent Experience (ARAX)
3939

4040
| Signal | Status | Notes |
41-
|--------|--------|-------|
41+
| ------ | ------ | ----- |
4242
| `summary_coverage` || Summary field presence |
4343
| `description_coverage` || Description field presence |
4444
| `type_specificity` | 📋 | Datatype richness |
@@ -50,7 +50,7 @@ This page tracks the implementation status of signals in the Jentic API AI-Readi
5050
## Agent Usability (AU)
5151

5252
| Signal | Status | Notes |
53-
|--------|--------|-------|
53+
| ------ | ------ | ----- |
5454
| `complexity_comfort` || Endpoint count + schema depth |
5555
| `distinctiveness` | 📋 | Semantic similarity analysis |
5656
| `pagination` | 📋 | Paginated GET detection |
@@ -63,7 +63,7 @@ This page tracks the implementation status of signals in the Jentic API AI-Readi
6363
## Security (SEC)
6464

6565
| Signal | Status | Notes |
66-
|--------|--------|-------|
66+
| ------ | ------ | ----- |
6767
| `auth_coverage` | 📋 | Protected sensitive operations |
6868
| `auth_strength` || Security scheme strength scoring |
6969
| `transport_security` | 📋 | HTTPS requirement |
@@ -74,7 +74,7 @@ This page tracks the implementation status of signals in the Jentic API AI-Readi
7474
## AI Discoverability (AID)
7575

7676
| Signal | Status | Notes |
77-
|--------|--------|-------|
77+
| ------ | ------ | ----- |
7878
| `descriptive_richness` || Semantic description quality |
7979
| `intent_phrasing` | 📋 | Verb-object clarity |
8080
| `workflow_context` | 📋 | Arazzo/workflow references |

0 commit comments

Comments
 (0)