Skip to content
This repository was archived by the owner on Jul 1, 2024. It is now read-only.

Commit c4e5b4e

Browse files
authored
README.md: tweak note/information blocks (#59)
The README is rendered in three places: - https://github.com/StyraInc/opa-typescript?tab=readme-ov-file#opa-typescript-sdk - https://styrainc.github.io/opa-typescript/ - https://www.npmjs.com/package/@styra/opa The github-specific note/information markup won't work on the other places. So removing it for clarity. Signed-off-by: Stephan Renatus <stephan@styra.com>
1 parent e0509eb commit c4e5b4e

File tree

2 files changed

+2
-10
lines changed

2 files changed

+2
-10
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ The Styra-supported driver to connect to Open Policy Agent (OPA) and Enterprise
55
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
66
[![NPM Version](https://img.shields.io/npm/v/%40styra%2Fopa?style=flat&color=%2324b6e0)](https://www.npmjs.com/package/@styra/opa)
77

8-
> [!IMPORTANT]
98
> The documentation for this SDK lives at https://docs.styra.com/sdk, with reference documentation available at https://styrainc.github.io/opa-typescript
109
1110
You can use the Styra OPA SDK to connect to [Open Policy Agent](https://www.openpolicyagent.org/) and [Enterprise OPA](https://www.styra.com/enterprise-opa/) deployments.
@@ -251,8 +250,7 @@ export class CatsController {
251250

252251
Please refer to [the repository's README.md](https://github.com/StyraInc/opa-typescript-example-nestjs/tree/main#opa-typescript-nestjs-example) for more details.
253252

254-
> [!NOTE]
255-
> For low-level SDK usage, see the sections below.
253+
> **Note**: For low-level SDK usage, see the sections below.
256254
257255
---
258256

typedoc.config.cjs

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,14 @@ module.exports = {
1919
excludeInternal: true,
2020
excludePrivate: true,
2121
excludeProtected: true,
22-
// excludeNotDocumented: true,
2322
entryPointStrategy: "resolve",
24-
// readme: "./README.md",
2523
plugin: ["typedoc-plugin-replace-text", "typedoc-plugin-extras"],
2624
favicon: "./.typedoc/favicon.ico",
2725
replaceText: {
2826
replacements: [
2927
{ pattern: "# OPA Typescript SDK", replace: "" },
3028
{
31-
pattern: `> \\[!NOTE\\]`,
32-
replace: "",
33-
},
34-
{
35-
pattern: `> For low-level SDK usage, see the sections below.\n\n---`,
29+
pattern: `> \\*\\*Note\\*\\*: For low-level SDK usage, see the sections below.`,
3630
replace: "",
3731
},
3832
{

0 commit comments

Comments
 (0)