Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.in-app-docs

Example showing how to use DocBlock for in-app documentation for non-technical users

examplesexamplev5.0.4stableservernode
@lssm-tech/example.in-app-docs
bun add @lssm-tech/example.in-app-docs
Package source ↗Manifest ↗

Manifest declarations describe the current workspace; they do not verify registry publication or runtime execution.

Package guide

Website: https://contractspec.io

Example showing how to use DocBlock for in-app documentation for non-technical users.

What This Demonstrates

  • DocBlock-driven in-app documentation pattern.
  • React viewer component for rendering DocBlocks.
  • User-facing documentation without technical jargon.
  • src/docs/ contains docblocks and documentation-facing exports.
  • src/ui/ contains packaged UI exports and embeddable views.
  • src/docs/ contains docblocks and documentation-facing exports.

Running Locally

From examples/in-app-docs:

  • bun run dev
  • bun run build
  • bun run test
  • bun run typecheck

Usage

Use @lssm-tech/example.in-app-docs as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.

Architecture

  • src/docs/ contains docblocks and documentation-facing exports.
  • src/example.ts is the runnable example entrypoint.
  • src/in-app-docs.feature.ts defines a feature entrypoint.
  • src/index.ts is the root public barrel and package entrypoint.
  • src/ui/ contains packaged UI exports and embeddable views.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./docs resolves through ./src/docs/index.ts.
  • Export ./docs/in-app-docs.docblock is an alias of ./docs and resolves through ./src/docs/index.ts.
  • Export ./example resolves through ./src/example.ts.
  • Export ./in-app-docs.feature resolves through ./src/in-app-docs.feature.ts.
  • Export ./ui resolves through ./src/ui/index.ts.
  • Export ./ui/InAppDocsViewer resolves through ./src/ui/InAppDocsViewer.tsx.

Local Commands

  • bun run dev — contractspec-bun-build dev
  • bun run build — contractspec-bun-build build
  • bun run test — bun test --pass-with-no-tests
  • bun run lint — bun lint:fix
  • bun run lint:check — biome check .
  • bun run lint:fix — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
  • bun run typecheck — tsgo --noEmit
  • bun run publish:pkg — bun publish --tolerate-republish --ignore-scripts --verbose
  • bun run publish:pkg:canary — bun publish:pkg --tag canary
  • bun run clean — rimraf dist .turbo
  • bun run build:bundle — contractspec-bun-build transpile
  • bun run build:types — contractspec-bun-build types
  • bun run prebuild — contractspec-bun-build prebuild

Recent Updates

  • Replace eslint+prettier by biomejs to optimize speed.
  • Missing contract layers.

Notes

  • Works alongside @lssm-tech/lib.contracts-spec, @lssm-tech/lib.example-shared-ui, @lssm-tech/tool.bun, @lssm-tech/tool.typescript.

Relationships

THIS PACKAGEexample.in-app-docs7 import paths

Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.

5 declarations

Declared capabilities

This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.

Scripts

  • publish:pkgbun publish --tolerate-republish --ignore-scripts --verbose
  • publish:pkg:canarybun publish:pkg --tag canary
  • buildcontractspec-bun-build build
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types
  • devcontractspec-bun-build dev
  • cleanrimraf dist .turbo
  • lintbun lint:fix
  • lint:fixnode ../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../scripts/biome.cjs check --write .
  • lint:checknode ../../scripts/biome.cjs check .
  • testbun test --pass-with-no-tests
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit