Skip to content

Commit 4ecb6d2

Browse files
committed
fixup: add cheatsheet links
Signed-off-by: Todd Baert <[email protected]>
1 parent e857dba commit 4ecb6d2

File tree

5 files changed

+8
-0
lines changed

5 files changed

+8
-0
lines changed

docs/concepts/selectors.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ In flagd, **selectors** provide a way to query flags based on different criteria
1313
- **Selector**: A query expression that filters flags by source, flag set, or other criteria
1414
- **Flag Set Metadata**: The selector information is "reflected" back in response metadata for transparency
1515

16+
See the [cheat sheet](../reference/cheat-sheet.md#using-the-selector-header) for practical examples of using selectors.
17+
1618
!!! tip
1719

1820
The `flagSetId` + `key` combination represents the unique identifier for a flag.

docs/concepts/syncs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
Syncs are a core part of flagd; they are the abstraction that enables different sources for feature flag definitions.
44
flagd can connect to one or more sync sources.
5+
See the [cheat sheet](../reference/cheat-sheet.md#running-flagd) for quick startup examples with different sync sources.
56

67
## Available syncs
78

docs/faq.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ flagd is sub-project of OpenFeature and aims to be fully [OpenFeature-compliant]
3030
3131
You can run flagd as a standalone application, accessible over HTTP or gRPC, or you can embed it into your application.
3232
Please see [architecture](./architecture.md) and [installation](./installation.md) for more information.
33+
For quick command examples, see the [cheat sheet](./reference/cheat-sheet.md).
3334

3435
---
3536

docs/reference/flagd-ofrep.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,5 @@ To evaluate all flags currently configured at flagd, use OFREP bulk evaluation r
2222
```shell
2323
curl -X POST 'http://localhost:8016/ofrep/v1/evaluate/flags'
2424
```
25+
26+
See the [cheat sheet](./cheat-sheet.md#ofrep-api-http) for more OFREP examples including context-sensitive evaluation and selectors.

docs/reference/grpc-sync-service.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,5 @@ final FlagdProvider flagdProvider =
4040
.selector("myFlags.json")
4141
.build());
4242
```
43+
44+
See the [cheat sheet](./cheat-sheet.md#grpc-sync-api-syncproto) for `grpcurl` examples using `FetchAllFlags` and `SyncFlags`.

0 commit comments

Comments
 (0)