FAQ

Is OpenLib only for desktop apps? #

No. OpenLib can list desktop, mobile, web, command-line, and self-hosted apps when they meet the app guidelines.

How does OpenLib decide what appears publicly? #

Public listings are reviewed for source availability, license clarity, metadata quality, link safety, category fit, and duplicate status. A listing does not need to be perfect, but it must be useful and honest.

Does every app need a download link? #

No. Web-only or self-hosted projects may use website, source, documentation, or release links instead.

Can commercial open-source apps be listed? #

Yes, if the app is meaningfully open source and the listing is transparent about licensing and paid services.

What if an app is no longer maintained? #

Maintainers may mark it deprecated, update the description, or remove unsafe links.

How do docs pages get URLs? #

Docs URLs are generated from page titles or explicit slugs in Markdown front matter. For example, Submit an App becomes /docs/submit-app.

Where are docs stored? #

Docs are stored as Markdown files in docs/content/ and generated into static pages under /docs/.

How do maintainers edit docs? #

Maintainers edit Markdown files locally under docs/content/, then run npm run docs:build to regenerate the static documentation pages.

Why are docs generated instead of loaded directly from Markdown? #

Generated pages are faster, easier to crawl, and easier to deploy on Firebase Hosting. The Markdown source stays simple for maintainers, while users receive static HTML pages with metadata, search data, table of contents, and navigation.

Where do docs screenshots live? #

Screenshot source files live in docs/assets/. The docs generator copies them to public/docs/assets/ so they can be served from /docs/assets/....

What should I do if a docs page looks stale? #

Run:

node scripts/bump-version.js
npm run docs:build

The version bump updates cache keys so browsers request the latest stylesheet and docs runtime.