Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ It auto-deploys via GitHub Actions on every push to `main` that touches

## Examples

- [`reference-docs/examples/oceanrunner.cddal`](reference-docs/examples/oceanrunner.cddal) — the canonical powertype demo (40 entities, 20 classes)
- [`oceanrunner.cddal`](https://github.com/opencdd/data-oceanrunner/blob/main/reference-docs/examples/oceanrunner.cddal) (in data-oceanrunner) — the canonical powertype demo
- [`reference-docs/202003-kagoshima-iec-def-sample.cddal`](reference-docs/202003-kagoshima-iec-def-sample.cddal) — minimal bare-`instance` form

## Standards background
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/cddal-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,6 @@ and property defined by IEC 61360-1.
## Further reading

- [Normative CDDAL specification](https://github.com/opencdd/cddal-spec)
- [OceanRunner worked example](../reference-docs/examples/oceanrunner.cddal)
- [OceanRunner worked example](https://github.com/opencdd/data-oceanrunner/blob/main/reference-docs/examples/oceanrunner.cddal)
- [Kagoshima bare-instance example](../reference-docs/202003-kagoshima-iec-def-sample.cddal)
- [Parcel format guide](parcel-format.md)
4 changes: 2 additions & 2 deletions docs/src/content/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ powertype pattern:
```ruby
require "opencdd"

db = Opencdd::Cddal.parse_file("reference-docs/examples/oceanrunner.cddal")
db = Opencdd::Cddal.parse_file("oceanrunner.cddal") # from opencdd/data-oceanrunner
# => #<Opencdd::Database classes=20 properties=19 ...>
```

Expand Down Expand Up @@ -259,5 +259,5 @@ end-to-end. See [cddal-syntax.md](cddal-syntax.md).
structure, header layout, and round-trip semantics
- **[architecture.md](architecture.md)** — how the gem is structured
internally, where to extend it
- **The fixtures** at `reference-docs/examples/oceanrunner.cddal`
- **The fixture** in [opencdd/data-oceanrunner](https://github.com/opencdd/data-oceanrunner)
(read it — it's heavily commented and exercises every feature)
4 changes: 2 additions & 2 deletions docs/src/content/docs/ontology.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ The powertype pattern is modeled explicitly:
```ruby
require "opencdd"

db = Opencdd::Cddal.parse_file("reference-docs/examples/oceanrunner.cddal")
db = Opencdd::Cddal.parse_file("oceanrunner.cddal") # from opencdd/data-oceanrunner

engine_type = db.find_by_code("ORA200")
single_diesel = db.find_by_code("ORA201")
Expand Down Expand Up @@ -202,7 +202,7 @@ explicit.

## Worked example: OceanRunner

Read [`reference-docs/examples/oceanrunner.cddal`](../reference-docs/examples/oceanrunner.cddal)
Read [`oceanrunner.cddal` in data-oceanrunner](https://github.com/opencdd/data-oceanrunner/blob/main/reference-docs/examples/oceanrunner.cddal)
alongside this section. It exercises:

- **M2 layer**: the `meta-class MDC_C002 { ... }` declarations register
Expand Down
Loading
Loading