Skip to content

Style the API reference with the Smile ID design system #31

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

Merged
Ed Fricker (beastawakens) merged 3 commits into from
Jul 27, 2026
Merged

Style the API reference with the Smile ID design system #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1954404
docs: restyle API reference with Smile ID design system tokens
beastawakens Jul 25, 2026
b316c85
docs: address review findings on the design system restyle
beastawakens Jul 25, 2026
e9d29f9
ci: match token declarations with [[:space:]] so tabs count
beastawakens Jul 25, 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
3 changes: 2 additions & 1 deletion .github/workflows/deploy-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ jobs:
run: |
set -euo pipefail
mkdir -p _site/specs/v3
cp docs/index.html _site/index.html
# Stage everything in docs/ so a new asset needs no workflow change.
cp -R docs/. _site/
cp specs/v3/*.yaml _site/specs/v3/

- name: Rewrite spec paths for flat layout
Expand Down
12 changes: 12 additions & 0 deletions .github/workflows/validate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,15 @@ jobs:

- name: Lint OpenAPI specs with Spectral
run: npx --yes @stoplight/spectral-cli@^6.14.0 lint specs/v3/*.yaml --fail-severity error

- name: Check design tokens referenced by the docs page are defined
run: |
set -euo pipefail
missing=0
for name in $(grep -oE -- '--si-[a-z0-9-]+' docs/index.html | sort -u); do
if ! grep -qE -- "^[[:space:]]*${name}[[:space:]]*:" docs/tokens.css; then
echo "Undefined design token referenced in docs/index.html: $name"
missing=1
fi
done
exit $missing
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,19 @@ OpenAPI 3.0 specifications for the Smile Identity v3 API.

Rendered API documentation is available via [GitHub Pages](https://smileidentity.github.io/api-reference/).

The page is styled with the Smile ID design system. `docs/tokens.css` is a verbatim copy of that
system's generated `dist/css/tokens.css` — don't hand-edit it. To refresh it, copy the file across
again and record the source revision below. Its own header refers to a `tokens/` directory and a
build command that belong to the design system repo, not this one.

| | |
|---|---|
| Copied from | Smile ID design system, `dist/css/tokens.css` |
| Copied on | 25 July 2026 |

CI checks that every `--si-*` token `docs/index.html` references is defined in `docs/tokens.css`, so
a rename in a refreshed copy fails the build rather than silently unstyling the page.

## Using the Specs

### Import into Postman
Expand Down
Loading
Loading