DEV Community

Justin Dah-kenangnon
Justin Dah-kenangnon

Posted on

I built a better documentation site for oidc-provider

While building a production-ready OpenID Connect server with oidc-provider, I ran into a recurring issue:

πŸ‘‰ the documentation is powerful, but not easy to navigate.

So I built this:

πŸ”— https://oidc-provider.dev/


The problem

oidc-provider has excellent documentation, but it is:

  • spread across multiple files (README, docs/, events, changelog)
  • not easily browsable
  • hard to search or explore progressively

This makes onboarding and day-to-day usage slower than it should be.


The solution

I created a dedicated documentation site that is:

  • πŸ“š fully browsable (multi-page navigation)
  • πŸ” searchable
  • 🧭 easier to explore than raw Markdown
  • πŸ—‚ structured by topics

Always in sync with upstream

The key design constraint was:

never diverge from the official documentation

So the site is:

  • automatically generated from official sources:

    • README
    • docs/*
    • CHANGELOG
    • events.md
  • continuously synced via GitHub Actions

Any update in the upstream repository is reflected automatically.


Why this matters

oidc-provider is a low-level, spec-compliant implementation.

That means:

  • a lot of behavior is driven by specs
  • documentation is dense and technical
  • discoverability is critical

This site aims to improve:

  • onboarding speed
  • feature discoverability
  • overall developer experience

What’s next

Planned additions:

  • real-world configuration examples
  • deployment patterns
  • integration guides

Links


Feedback

If you are using oidc-provider, feedback is highly valuable.

The goal is to make the ecosystem easier to approach without altering its philosophy.

Top comments (0)