Skip to content

Commit 3d3edb7

Browse files
authored
Update intro/README (#384)
1 parent 62c1aa5 commit 3d3edb7

2 files changed

Lines changed: 6 additions & 8 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,4 +305,6 @@ For more insight into why we decided to completely fork see [#47](https://github
305305

306306
## Support
307307

308-
Please read [SUPPORT.md](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/SUPPORT.md) for details on how to get support for this project.
308+
See [SUPPORT.md](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/SUPPORT.md) for our support agreement and guidelines.
309+
310+
If you believe you found a bug or have an idea you'd like to suggest you may [report an issue](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/new/choose) or [start a discussion](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/discussions/new/choose).

demo/docs/intro.mdx

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ yarn watch:demo
374374

375375
## Credits
376376

377-
Special thanks to @bourdakos1 (Nick Bourdakos), the author of [docusaurus-openapi](https://github.com/cloud-annotations/cloud-annotations), which this project is heavily based on.
377+
Special thanks to @bourdakos1 (Nick Bourdakos), the author of [docusaurus-openapi](https://github.com/cloud-annotations/docusaurus-openapi), which this project is heavily based on.
378378

379379
For more insight into why we decided to completely fork see [#47](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/47)
380380

@@ -386,10 +386,6 @@ For more insight into why we decided to completely fork see [#47](https://github
386386

387387
## Support
388388

389-
Please read [SUPPORT.md](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/SUPPORT.md) for details on how to get support for this project.
389+
See [SUPPORT.md](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/SUPPORT.md) for our support agreement and guidelines.
390390

391-
## Where's the "Try It" feature?
392-
393-
You may have noticed that our plugin does not include a "try it" feature for generating and sending API requests from the browser. Although we recognize the utility of such a feature, we decided it would go against security best practices to encourage sharing API keys/tokens with the browser without proper safeguards in place (e.g. session authentication, OpenID, short-lived tokens, etc.).
394-
395-
That said, we might one day revisit this use case if we can engineer a safer way to enable it.
391+
If you believe you found a bug or have an idea you'd like to suggest you may [report an issue](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/new/choose) or [start a discussion](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/discussions/new/choose).

0 commit comments

Comments
 (0)