Skip to content

Commit

Permalink
Fix example links in relationship and query manuals for generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SanderMertens committed Jul 27, 2022
1 parent e7f7dcd commit b0aa797
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
10 changes: 4 additions & 6 deletions docs/Queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ Here are some of the highlights of Flecs queries:

| Name | Description |
|--------------|-------------|
| Query | A list of conditions used to match entities |
| Term | A single element of a query |
| Id | An id that can be matched, added and removed |
| Component | Id with a single element (same as an entity id) |
| Pair | Id with two elements |
Expand All @@ -47,10 +45,10 @@ Here are some of the highlights of Flecs queries:
## Examples
Make sure to check out the code examples in the repository:

- [queries (C)](/examples/c/queries)
- [queries (C++)](/examples/cpp/queries)
- [rules (C)](/examples/c/rules)
- [rules (C++)](/examples/cpp/rules)
- [queries (C)](https://github.com/SanderMertens/flecs/examples/c/queries)
- [queries (C++)](https://github.com/SanderMertens/flecs/examples/cpp/queries)
- [rules (C)](https://github.com/SanderMertens/flecs/examples/c/rules)
- [rules (C++)](https://github.com/SanderMertens/flecs/examples/cpp/rules)

## Query Types
Flecs has different query types, which are optimized for different kinds of use cases. This section provides a brief overview of each kind:
Expand Down
10 changes: 5 additions & 5 deletions docs/Relationships.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ The relationships feature makes it possible to describe entity graphs natively i

Adding/removing relationships is similar to adding/removing regular components, with as difference that instead of a single component id, a relationship adds a pair of two things to an entity. In this pair, the first element represents the relationship (e.g. "Eats"), and the second element represents the relationship target (e.g. "Apples").

Relationships can be used to describe many things, from hierarchies to inventory systems to trade relationships betweein players in a game. The following sections go over how to use relationships, and what features they support.

## Definitions

| Name | Description |
| Name | Description |
|--------------|-------------|
| Query | A list of conditions used to match entities |
| Term | A single element of a query |
| Id | An id that can be added and removed |
| Component | Id with a single element (same as an entity id) |
| Pair | Id with two elements |
Expand All @@ -20,8 +20,8 @@ Adding/removing relationships is similar to adding/removing regular components,
## Examples
Make sure to check out the code examples in the repository:

- [relationships (C)](/examples/c/relationships)
- [relationships (C++)](/examples/cpp/relationships)
- [relationships (C)](https://github.com/SanderMertens/flecs/examples/c/relationships)
- [relationships (C++)](https://github.com/SanderMertens/flecs/examples/cpp/relationships)

## Introduction
The following code is a simple example that uses relationships:
Expand Down

0 comments on commit b0aa797

Please sign in to comment.