Skip to content

IS-11008 HAAPI FE Lib documentation #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aleixsuau wants to merge 7 commits into
base: dev
Choose a base branch
from
Open

IS-11008 HAAPI FE Lib documentation #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
eb8a08e
IS-11008 Document the HAAPI React SDK exports (TSDoc).
aleixsuau Jul 29, 2026
b9c4267
IS-11008 Add the SDK docs tree: section READMEs, runnable examples, h…
aleixsuau Jul 29, 2026
ba566e0
IS-11008 Docs tooling and config; point repo pages at the Curity docs…
aleixsuau Jul 29, 2026
f07e8b0
IS-11008 Use a unique password filler in auto-submitted examples (avo…
aleixsuau Jul 30, 2026
2446c7a
IS-11008 Smoke-test the docs examples in CI.
aleixsuau Jul 30, 2026
33a2d4c
IS-11008 Reconcile with IS-6007 merge; Copilot review fixes.
aleixsuau Aug 4, 2026
74cece5
IS-11008 Use descriptive link texts in the SDK README.
aleixsuau Aug 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/lwa-github-ci-workflow.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,16 @@ jobs:
run: npm ci

- name: SDK — Check Formatting
run: npm run prettier-check -w src/haapi-react-sdk
run: npm run prettier-check -w @curity/haapi-react-sdk

- name: SDK — Lint
run: npm run lint -w src/haapi-react-sdk
run: npm run lint -w @curity/haapi-react-sdk

- name: SDK — Typecheck
run: npm run typecheck -w src/haapi-react-sdk
run: npm run typecheck -w @curity/haapi-react-sdk

- name: SDK — Run Tests
run: npm run test -w src/haapi-react-sdk -- run
run: npm run test -w @curity/haapi-react-sdk -- run

- name: App — Check Formatting
run: npm run prettier-check -w src/haapi-react-app
Expand Down
19 changes: 19 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,14 @@
width: fit-content;
}

.documentation {
margin-top: 1.5rem;
width: 100%;
text-align: center;
border-top: 1px solid #eee;
padding-top: 1rem;
}

.status {
margin-top: auto;
padding-top: 1rem;
Expand Down Expand Up @@ -525,12 +533,23 @@ <h2>HAAPI React App</h2>
<span>Open previewer</span>
</a>
<small class="card-url">http://localhost:5174/</small>
<div class="documentation">
<a
href="https://curity.io/docs/identity-server/developer-guide/haapi-sdks/web-sdk"

@luisgoncalves luisgoncalves Aug 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hard-coding these links is always a bit tricky for maintenance, but I see how it's useful (and they probabyl need to be stable for SEO purposes et al, anyway). So, I suggest adding docs lnks to the other two cards as well, pointing to their relevant sections in product docs.

Also, I think the button is way too big. Maybe a simple link is enough? And saying "Read documentation" is probably enough as well - no need to duplicate part of the card title.

Image

@urre urre Aug 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this can be just "Read Docs ". The button can also come after the other button so it doesn't shift layout in the card so much, for example:

CleanShot 2026-08-10 at 08 37 22@2x

@urre urre Aug 10, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please use trailing slash on this link

target="_blank"
rel="noopener noreferrer"
class="button button-primary-outline button-medium w100 mt2"
Comment thread
Copilot marked this conversation as resolved.
>
<span>Read HAAPI React SDK documentation</span>
</a>
</div>
<div class="commands">
<h3>Useful Commands</h3>
<code>npm install</code>
<code>npm run start:haapi-react-app</code>
<code>npm run build:haapi-react-app</code>
</div>

<div
class="status"
data-tooltip="Note: It may take a few seconds for the preview server to be ready"
Expand Down
Loading
Loading