Thomas Heartman
75e6df5b5b
docs: document Proxy openAPI integration ( #1571 )
...
* docs: document the new OpenAPI functionality
* docs: add availability note for openapi integration
* docs: rewrite openapi section
2022-05-09 09:24:48 +02:00
Thomas Heartman
9db36013b1
chore: delete reference doc scaffolding
2022-04-13 15:41:02 +02:00
Thomas Heartman
f1a4347534
chore: delete duplicate configuration section
2022-04-13 15:40:11 +02:00
Thomas Heartman
b43d9b05db
docs: link to the how-to guide from the proxy reference docs
2022-04-13 15:39:04 +02:00
Thomas Heartman
ac9f800ba8
docs: add details to the configuration option table
2022-04-13 15:37:04 +02:00
Thomas Heartman
8f3018d092
docs: ad configuration variables to proxy reference
2022-04-12 16:00:07 +02:00
Thomas Heartman
29f77b8e27
docs: add configuration options header.
2022-04-12 15:59:12 +02:00
Thomas Heartman
3c63adddab
docs: add more scaffolding to proxy docs
2022-04-12 15:59:12 +02:00
Thomas Heartman
4b0b08a2ea
docs: start moving proxy details around
2022-04-12 15:59:12 +02:00
Thomas Heartman
e6d939508d
fix: correct the description of disabled variants
2022-03-04 08:20:55 +01:00
Thomas Heartman
0b69e1751e
chore: remove trailing full stop.
2022-02-09 13:44:58 +01:00
Thomas Heartman
673b297209
docs: use some-secret instead of some-public-key
...
The rest of the docs all use `some-secret`, so having only this **one**
place use `some-public-key` is really misleading.
2022-02-04 10:13:27 +01:00
Ivar Conradi Østhus
a5367ef9f8
docs: improve proxy commands
2022-01-21 10:13:22 +01:00
Thomas Heartman
cf35efedee
Apply suggestions from code review
...
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-01-17 14:55:06 +01:00
Thomas Heartman
611602c781
docs: add steps for running the proxy via Node
...
Also: restructure the steps relating to running it via docker to align
better and to avoid repeating information.
2022-01-14 13:53:09 +01:00
Thomas Heartman
0892b1aca0
docs(custom strats): add note to proxy docs about custom strats.
2021-12-22 13:23:34 +01:00
Thomas Heartman
815fc353ec
Apply suggestions from code review
...
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2021-12-06 14:06:14 +01:00
Thomas Heartman
d936a0d4ed
docs: Android SDK: reformat and add more details on client secrets
2021-12-06 12:59:32 +01:00
Thomas Heartman
24bf9b7012
docs: explain what the proxy configuration variables are.
2021-12-06 12:35:49 +01:00
Thomas Heartman
e41d6b0f4d
docs: describe the shape of the data returned by the Unleash proxy
...
This commit attempts to explain what the proxy returns in more detail,
explaining how payloads work and what the `enabled` properties mean
and how they relate to the rest of the content.
2021-11-30 12:52:46 +01:00
Thomas Heartman
106c9cebde
docs: Clarify that the proxy does not expose disabled flags ( #1094 )
...
* docs: fix typo 'preformat' -> 'performant'
* docs: clarify that proxy returns _only_ enabled toggles
This is based on feedback we got that said:
> Right now biggest disappointment is that docs doesn't match an exact
> JS proxy libraries and their usage. For example, we couldn't make
> feature flag return enabled: false, instead it just hides/not return
> the flag at all.
2021-11-08 22:58:02 +01:00
Ivar Conradi Østhus
ffec4f6342
fix: rename websitev2 to website
2021-10-26 11:25:19 +02:00
