Skip to content

Commit

Permalink
refactor: drop legacy codename in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ebastien committed Nov 9, 2023
1 parent 8da9f4d commit 6f03118
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ theme: just-the-docs
color_scheme: oxlip

aux_links:
"OAL playground":
"Oxlip playground":
- "https://oxlip-lang.github.io/oxlip-playground"
"OAL on GitHub":
"Oxlip on GitHub":
- "https://github.com/oxlip-lang/oal"

aux_links_new_tab: true

nav_external_links:
- title: Playground
url: https://oxlip-lang.github.io/oxlip-playground
- title: OAL on GitHub
- title: Oxlip on GitHub
url: https://github.com/oxlip-lang/oal

callouts:
Expand Down
4 changes: 2 additions & 2 deletions src/doc/capabilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ nav_order: 2

# Capabilities

To address the challenges of handwriting OpenAPI and managing large definitions across multiple teams, OAL offers the following capabilities:
To address the challenges of handwriting OpenAPI and managing large definitions across multiple teams, Oxlip offers the following capabilities:

- __human readable__: statement-based language to help with readability (e.g. for code reviews);
- __declarative__: as with bare OpenAPI in either JSON or YAML. Not a general purpose language;
- __modular__: project structure can be organized freely into folders and modules;
- __composable__: REST concepts are mapped to types and operators, enabling the composition of low-level values (e.g. JSON properties) into higher-level entities (e.g. HTTP end-points) as language expressions;
- __functional__: behavior can be encapsulated in functions, generalized and reused at will.

OAL also enhances OpenAPI with experimental support for [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS).
Oxlip also enhances OpenAPI with experimental support for [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS).

---

Expand Down
2 changes: 1 addition & 1 deletion src/doc/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav_order: 7
---

# Design decisions
If you are curious about some of the technical decisions behind OAL:
If you are curious about some of the technical decisions behind Oxlip:
- Rust got chosen both as a learning material and because of the maturity of its ecosystem for the development of compilers.
- An external domain specific language was preferred to minimize dependencies with language SDKs and runtimes for end-users.
- The parser emits a concrete syntax tree instead of an abstract syntax tree to enable interactive source code refactoring capabilities.
Expand Down
2 changes: 1 addition & 1 deletion src/doc/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The compiled OpenAPI definition is available in [Redoc](https://redocly.github.i

```oal
/*
* Example of OAL definition for the Restbucks imaginary coffee shop
* Example of Oxlip definition for the Restbucks imaginary coffee shop
* https://www.infoq.com/articles/webber-rest-workflow/
*/
Expand Down
2 changes: 1 addition & 1 deletion src/doc/hello.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Copy and paste the following line into a file named `hello.oal`:
res /hello on get -> { 'greetings [str] };
```

Run the OAL compiler:
Run the Oxlip compiler:

```
oal-cli -m ./hello.oal -t hello.yaml
Expand Down
2 changes: 1 addition & 1 deletion src/doc/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ Across a domain, this effectively defines the graph of possible state transition

{: .note }
There is no _relation_ schema in OpenAPI. When used as a schema, only the URI part of a relation is preserved.
Next to OpenAPI, OAL is experimenting with complementary formats to retain the state transition information in the compiler output.
Next to OpenAPI, Oxlip is experimenting with complementary formats to retain the state transition information in the compiler output.

### Schema operators
A conjunction of schemas is expressed with the `&` operator.
Expand Down
6 changes: 3 additions & 3 deletions src/doc/related.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Related work"
nav_order: 8
---

# Related work and comparison with OAL
# Related work and comparison with Oxlip

## [TypeSpec](https://github.com/microsoft/typespec) / [Smithy IDL](https://github.com/awslabs/smithy)

Expand Down Expand Up @@ -34,10 +34,10 @@ _(TBD)_

## [Oxlip API Language](https://doc.oxlip-lang.org)

OAL takes a different approach by defining an algebra and a functional evaluation strategy
Oxlip takes a different approach by defining an algebra and a functional evaluation strategy
dedicated to the composition of low-level REST concepts into modular OpenAPI definitions.
One can argue that extensible languages like Dhall could achieve similar objectives.
As a specialized language, OAL has the potential to provide a more compact syntax,
As a specialized language, Oxlip has the potential to provide a more compact syntax,
easier to learn, to read and to manage at scale.

---
Expand Down
2 changes: 1 addition & 1 deletion src/doc/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nav_order: 4
The `oal-client` crate contains two binaries, the command line interface and the LSP server.

## Command line interface
The `oal-cli` binary is the command line interface to the OAL compiler.
The `oal-cli` binary is the command line interface to the Oxlip compiler.

```
oal-cli [OPTIONS]
Expand Down
8 changes: 4 additions & 4 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ title: Home
nav_order: 1
---

This is the documentation for the __Oxlip API Language__ (a.k.a OAL).
This is the documentation for the __Oxlip API Language__.

OAL is a high-level functional programming language for designing [OpenAPI](https://www.openapis.org/what-is-openapi) definitions.
Oxlip is a high-level functional programming language for designing [OpenAPI](https://www.openapis.org/what-is-openapi) definitions.
As an [Interface Description Language](https://en.wikipedia.org/wiki/Interface_description_language), it is not general purpose.
The motivation is to alleviate the pain of managing OpenAPI in JSON or YAML by hand and at scale.
OAL defines algebraic abstractions over [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) concepts, not too dissimilar to [Sass/SCSS over CSS](https://sass-lang.com/).
Oxlip defines algebraic abstractions over [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) concepts, not too dissimilar to [Sass/SCSS over CSS](https://sass-lang.com/).

There are pros and cons to both _API-design-first_ and OpenAPI generated from implementation.
As OpenAPI is better produced or consumed by machines rather than humans, OAL tries to help _API-design-first_ teams with better tooling.
As OpenAPI is better produced or consumed by machines rather than humans, Oxlip tries to help _API-design-first_ teams with better tooling.

---

Expand Down

0 comments on commit 6f03118

Please sign in to comment.