Website · Security · Open source
Hardware Security SDK
Hardware Security SDK is an open source library for FIDO2 keys and smart cards across multiple platforms.
Visit site (hwsecurity.dev)- Year
- 2021
- Type
- Website, Security, Open source
- Stack
- GitHub Pages, Hugo
- Live site
- hwsecurity.dev
About the project
The Hardware Security SDK is an open source library that lets apps work with FIDO2 security keys and smart cards. Its domain, hwsecurity.dev, is the short address developers type or find in a search.
The question was what that address should show. A library does not need a marketing site that repeats, and slowly contradicts, what is in the repository. We set the domain up to send developers straight to the public repository, where the code and the documentation are maintained.
What we did
- Domain setup and redirect
- Advice on where the documentation should live
Case study
Challenge
Developers needed a simple entry point to find documentation, releases, and project discussions. A separate marketing site would add unnecessary complexity for an open source library.
Solution
We configured hwsecurity.dev to redirect directly to the public repository where documentation and code are maintained. This approach centralizes all resources in one place where developers already work.
Results
The domain takes developers to the repository, keeping code, documentation, releases and issue tracking together.
In detail
The smallest site that works
The domain answers with a redirect to the repository. There is no second copy of the readme to keep in sync and no page that can fall behind the code.
Everything where developers already are
Code, documentation, releases and issue tracking sit together in the repository. A developer who arrives from the domain is already in the place where they can read, download and report.
A decision, not a shortcut
Not building something is also a result. For a library with a technical audience, a separate site would have added upkeep without answering any question the repository does not answer better.
How it is built
- HugoStatic site generator
- A static site generator. Pages are built once as plain HTML, so there is no database to attack or slow down, and the whole site builds in seconds.
- GitHub PagesHosting
- Static hosting straight from the repository: merging a change publishes it, with no server to patch.
Lighthouse scores
- Performance
- 71
- Accessibility
- 100
- Best practices
- 96
- SEO
- 100
Lighthouse desktop scores, measured on the live sites.
Start with a price, then a conversation.
Build an estimate in a couple of minutes, or tell us what you need and we will outline the work, price and schedule.