Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix 404s on Rustdocs for auraed #492

Merged
merged 4 commits into from
Jan 14, 2024
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 Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ endif

.PHONY: docs-crates
docs-crates: musl $(GEN_TS) $(GEN_RS) ## Build the crate (documentation)
$(cargo) doc --target $(uname_m)-unknown-linux-musl --no-deps --package auraed
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this breaks anything. Assuming our CI would run with the correct rust target by default, I think we're fine. This change allows all the rustdocs to be unified and have links to each crate on the left navigation.

image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this breaks anything. Assuming our CI would run with the correct rust target by default, I think we're fine. This change allows all the rustdocs to be unified and have links to each crate on the left navigation.

image

it shouldn't, no. our ci doesn't use the right target (musl) but for docs I suspect it doesnt matter...

$(cargo) doc --no-deps --package auraed
$(cargo) doc --no-deps --package auraescript
$(cargo) doc --no-deps --package client
$(cargo) doc --no-deps --package aer
Expand Down
6 changes: 3 additions & 3 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For example, Aurae has the concept of an `Executable` resource which represents

The core resources are intended to be fundamental and composable, similar to the objects and structures found in modern programming languages.

Resources are defined directly in the corresponding protobuf definition and later generated into code for various languages. A resource's corresponding message should never be passed to directly to, or received directly from an RPC.
Resources are defined directly in the corresponding protobuf definition and later generated into code for various languages. A resource's corresponding message should never be passed directly to, or received directly from an RPC.

In protobuf terms a resource is a [message](https://protobuf.dev/programming-guides/proto3/#simple).

Expand All @@ -31,7 +31,7 @@ Services are a section of the API designed to be a way of grouping functionality
A service should be discreet in the terms of how it mutates the system. For example if a service starts, it should stop. If a service allocates, it should free. And so on.

Services should be named after a resource or set of functionality around common resources.
Services should follow the `service NameService` paradigm as defined in the [style guide](https://protobuf.dev/programming-guides/style/)
Services should follow the `service NameService` paradigm as defined in the [style guide](https://protobuf.dev/programming-guides/style/).

For example the service that mutates a `Cell` should be called `CellService`.

Expand Down Expand Up @@ -89,7 +89,7 @@ enum FooBar {
}
```

A notable exception to the public specification above is the Aurae projects preference for standardizing the objects that are used as the request and response messages.
A notable exception to the public specification above is the Aurae project's preference for standardizing the objects that are used as the request and response messages.

The traditional convention that is meant to reduce the likelihood of future breaking changes and ease the creation of macros for generating code:

Expand Down
4 changes: 2 additions & 2 deletions docs/stdlib/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For example, Aurae has the concept of an `Executable` resource which represents

The core resources are intended to be fundamental and composable, similar to the objects and structures found in modern programming languages.

Resources are defined directly in the corresponding protobuf definition and later generated into code for various languages. A resource's corresponding message should never be passed directly to or received directly from an RPC.
Resources are defined directly in the corresponding protobuf definition and later generated into code for various languages. A resource's corresponding message should never be passed directly to, or received directly from an RPC.

In protobuf terms a resource is a [message](https://protobuf.dev/programming-guides/proto3/#simple).

Expand All @@ -37,7 +37,7 @@ For example the service that mutates a `Cell` should be called `CellService`.

### What are functions?

A function is a discreet piece of functionality designed to execute on the "backend," or directly by an Aurae Daemon server.
A function is a discreet piece of functionality designed to execute on the "backend", or directly by an Aurae Daemon server.

The library is designed to be executed procedurally and quickly. Many function calls per second is a reasonable expectation for any client.

Expand Down
7 changes: 4 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,13 @@ nav:
- Reference:
- auraed: /crate/auraed
- auraescript: /crate/auraescript
- implementors: /crate/implementors
- macros: /crate/macros
- client: /crate/client
- aer: /crate/aer
- src:
- auraed: /crate/src/auraed/lib.rs.html
- auraescript: /crate/src/auraescript/lib.rs.html
- macros: /crate/src/macros/lib.rs.html
- client: /crate/src/client/lib.rs.html
- aer: /crate/src/aer/lib.rs.html
- Blog:
- Isolation with Aurae Cells: /blog/2022-10-24-aurae-cells
- Cgroups in Aurae: /blog/2022-12-11-cgroups
Expand Down
Loading