From f8cf14fc48601f126eaa1ddabe99dfadf75e4209 Mon Sep 17 00:00:00 2001 From: Sander Mertens Date: Tue, 26 Jul 2022 23:13:33 -0700 Subject: [PATCH] Fix example links in relationship and query manuals for generated docs --- docs/Queries.md | 12 ++++++------ docs/Relationships.md | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/Queries.md b/docs/Queries.md index 4f64f7d00e..c14982a754 100644 --- a/docs/Queries.md +++ b/docs/Queries.md @@ -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 | @@ -47,10 +45,12 @@ 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) +https://github.com/SanderMertens/flecs/tree/master/examples + + - [queries (C)](https://github.com/SanderMertens/flecs/tree/master/examples/c/queries) + - [queries (C++)](https://github.com/SanderMertens/flecs/tree/master/examples/cpp/queries) + - [rules (C)](https://github.com/SanderMertens/flecs/tree/master/examples/c/rules) + - [rules (C++)](https://github.com/SanderMertens/flecs/tree/master/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: diff --git a/docs/Relationships.md b/docs/Relationships.md index 5d586731c2..152b19996b 100644 --- a/docs/Relationships.md +++ b/docs/Relationships.md @@ -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 | @@ -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/tree/master/examples/c/relationships) + - [relationships (C++)](https://github.com/SanderMertens/flecs/tree/master/examples/cpp/relationships) ## Introduction The following code is a simple example that uses relationships: