paperlesspaper/paperlesspaper-docs
Watch
1
0
Fork
You've already forked paperlesspaper-docs
 0
mirror of https://github.com/paperlesspaper/paperlesspaper-docs.git synced 2026-10-13 22:12:16 +02:00
Code Issues Projects Releases Packages Wiki Activity
Documentation for paperlesspaper https://docs.paperlesspaper.de
33 commits 2 branches 0 tags 12 MiB
  • MDX 69.6%
  • TypeScript 29.5%
  • CSS 0.5%
  • JavaScript 0.4%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Robert Gühne f6c9dcf617 docs: document Open Integration content push and webhooks
2026-09-21 11:44:37 +02:00
app Update .gitignore and refactor API component imports in documentation pages 2026-05-26 11:03:00 +02:00
components feat: update API guide metadata, funny logo added :) 2026-04-27 11:41:02 +02:00
content/docs docs: document Open Integration content push and webhooks 2026-09-21 11:44:37 +02:00
lib Add manufacturing documentation for laser cutting and overview 2026-05-28 14:50:00 +02:00
.env.example Migrate .env configuration to .env.example: remove existing .env file and create example with OpenAPI URL 2026-05-15 03:25:53 +02:00
.gitignore Update .gitignore and refactor API component imports in documentation pages 2026-05-26 11:03:00 +02:00
cli.json feat: add API guide for updating images and Open Integration documentation 2026-04-26 23:09:58 +02:00
favicon.png feat: add API guide for updating images and Open Integration documentation 2026-04-26 23:09:58 +02:00
next-env.d.ts Add USB Serial documentation and Open Integration Toolkit guide 2026-07-03 14:20:14 +02:00
next.config.mjs Refactor API routes and add LLM text processing: update markdown URL generation, implement structured data handling, and create new routes for LLM text retrieval 2026-05-15 03:20:36 +02:00
package.json feat: add API guide for updating images and Open Integration documentation 2026-04-26 23:09:58 +02:00
postcss.config.mjs Initial commit 2026-04-21 21:53:03 +02:00
README.md fix(package): node version 2026-04-21 22:02:47 +02:00
source.config.ts Initial commit 2026-04-21 21:53:03 +02:00
tsconfig.json Initial commit 2026-04-21 21:53:03 +02:00
yarn.lock feat: add API guide for updating images and Open Integration documentation 2026-04-26 23:09:58 +02:00

README.md

paperlesspaper-docs

Work in progress: This new documentation is new and subject to change. PRs are welcome!

Live on docs.paperlesspaper.de

Developer documentation for the paperlesspaper API.

This repository contains a Next.js 16 documentation site built with FumaDocs. It combines handwritten MDX guides from content/docs with API reference pages generated from the live OpenAPI schema at https://api.paperlesspaper.de/openapi.json.

Stack

  • Next.js 16
  • React 19
  • FumaDocs
  • FumaDocs OpenAPI
  • Tailwind CSS 4

Local development

Install dependencies:

yarn install

Start the development server:

yarn dev

Open http://localhost:3000.

Available scripts

  • yarn dev starts the local development server.
  • yarn build creates a production build.
  • yarn start serves the production build.
  • yarn lint runs the project linter.

Content model

  • content/docs contains the authored MDX pages and sidebar metadata.
  • lib/openapi.ts points FumaDocs at the live paperlesspaper OpenAPI schema.
  • app contains the Next.js app router entrypoints and FumaDocs page wiring.
  • components contains custom MDX and UI helpers for the docs experience.

Generated API reference

The API reference is generated from the live schema configured in lib/openapi.ts. That means local and deployed docs reflect the current published OpenAPI document rather than a checked-in schema snapshot.

If the schema changes, the generated endpoint reference updates with it the next time the site is built.