{"id":"@lssm-tech/example.in-app-docs","slug":"example.in-app-docs","name":"@lssm-tech/example.in-app-docs","version":"5.0.4","path":"examples/in-app-docs","manifestPath":"examples/in-app-docs/package.json","manifestBlobSha":"2fe0cf2c0f289db19af6810b21b43f63618de336","layer":"examples","physicalArea":null,"primaryArea":"examples-and-patterns","classification":{"privateDeclared":null,"catalogFamily":"solutions","catalogKind":"example","catalogStatus":"active","adoptionMode":"reference-only","stability":"stable"},"description":"Example showing how to use DocBlock for in-app documentation for non-technical users","descriptionOrigin":"package.json","catalog":{"family":"solutions","kind":"example","status":"active","adoptionMode":"reference-only","stability":"stable","platforms":["server"],"runtimes":["node"],"entrypoints":[".","./docs","./docs/in-app-docs.docblock","./example","./in-app-docs.feature","./ui","./ui/InAppDocsViewer"],"documentation":[{"title":"Example In App Docs documentation","url":"https://www.npmjs.com/package/%40lssm-tech%2Fexample.in-app-docs","kind":"readme"}],"examples":[],"replacements":[],"nonAdoptableRationale":"This example is published for reference and learning, not as a reusable library dependency.","visualTesting":{"status":"deferred","owner":"@contractspec-core","targetWave":"wave-3-react-packages","rationale":"Foundational Storybook adoption establishes shared catalogs and guardrails before this package migrates."}},"canonicalImports":[],"scripts":{"publish:pkg":"bun publish --tolerate-republish --ignore-scripts --verbose","publish:pkg:canary":"bun publish:pkg --tag canary","build":"contractspec-bun-build build","build:bundle":"contractspec-bun-build transpile","build:types":"contractspec-bun-build types","dev":"contractspec-bun-build dev","clean":"rimraf dist .turbo","lint":"bun lint:fix","lint:fix":"node ../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../scripts/biome.cjs check --write .","lint:check":"node ../../scripts/biome.cjs check .","test":"bun test --pass-with-no-tests","prebuild":"contractspec-bun-build prebuild","typecheck":"tsgo --noEmit"},"scriptStatus":"complete pinned manifest","dependencies":{"@lssm-tech/lib.contracts-spec":"workspace:^","@lssm-tech/lib.design-system":"workspace:^","@lssm-tech/lib.example-shared-ui":"workspace:^","react":"catalog:","react-dom":"catalog:"},"devDependencies":{"@lssm-tech/tool.typescript":"workspace:*","typescript":"catalog:","@types/react":"catalog:types","@types/react-dom":"catalog:types","@lssm-tech/tool.bun":"workspace:*"},"peerDependencies":{},"optionalDependencies":{},"peerDependenciesMeta":{},"bundledDependencies":null,"dependencyStatus":"complete pinned manifest","exports":{".":"./src/index.ts","./docs":"./src/docs/index.ts","./docs/in-app-docs.docblock":"./src/docs/index.ts","./example":"./src/example.ts","./in-app-docs.feature":"./src/in-app-docs.feature.ts","./ui":"./src/ui/index.ts","./ui/InAppDocsViewer":"./src/ui/InAppDocsViewer.tsx"},"publishExports":{".":{"types":"./dist/index.d.ts","browser":"./dist/browser/index.js","bun":"./dist/index.js","node":"./dist/node/index.js","default":"./dist/index.js"},"./docs":{"types":"./dist/docs/index.d.ts","browser":"./dist/browser/docs/index.js","bun":"./dist/docs/index.js","node":"./dist/node/docs/index.js","default":"./dist/docs/index.js"},"./docs/in-app-docs.docblock":{"types":"./dist/docs/index.d.ts","browser":"./dist/browser/docs/index.js","bun":"./dist/docs/index.js","node":"./dist/node/docs/index.js","default":"./dist/docs/index.js"},"./example":{"types":"./dist/example.d.ts","browser":"./dist/browser/example.js","bun":"./dist/example.js","node":"./dist/node/example.js","default":"./dist/example.js"},"./in-app-docs.feature":{"types":"./dist/in-app-docs.feature.d.ts","browser":"./dist/browser/in-app-docs.feature.js","bun":"./dist/in-app-docs.feature.js","node":"./dist/node/in-app-docs.feature.js","default":"./dist/in-app-docs.feature.js"},"./ui":{"types":"./dist/ui/index.d.ts","browser":"./dist/browser/ui/index.js","bun":"./dist/ui/index.js","node":"./dist/node/ui/index.js","default":"./dist/ui/index.js"},"./ui/InAppDocsViewer":{"types":"./dist/ui/InAppDocsViewer.d.ts","browser":"./dist/browser/ui/InAppDocsViewer.js","bun":"./dist/ui/InAppDocsViewer.js","node":"./dist/node/ui/InAppDocsViewer.js","default":"./dist/ui/InAppDocsViewer.js"}},"types":"./dist/index.d.ts","files":["LICENSE","README.md","dist","!**/*.test.*","!**/*.spec.*","!**/*.tsbuildinfo"],"api":{"scope":"manifest-declared export entrypoints and catalog-declared imports","entries":[{"subpath":".","importPath":"@lssm-tech/example.in-app-docs","target":"./src/index.ts","targets":[{"conditions":[],"target":"./src/index.ts","sourcePath":"examples/in-app-docs/src/index.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/examples/in-app-docs/src/index.ts","sourceStatus":"verified source file"}]},{"subpath":"./docs","importPath":"@lssm-tech/example.in-app-docs/docs","target":"./src/docs/index.ts","targets":[{"conditions":[],"target":"./src/docs/index.ts","sourcePath":"examples/in-app-docs/src/docs/index.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/examples/in-app-docs/src/docs/index.ts","sourceStatus":"verified source file"}]},{"subpath":"./docs/in-app-docs.docblock","importPath":"@lssm-tech/example.in-app-docs/docs/in-app-docs.docblock","target":"./src/docs/index.ts","targets":[{"conditions":[],"target":"./src/docs/index.ts","sourcePath":"examples/in-app-docs/src/docs/index.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/examples/in-app-docs/src/docs/index.ts","sourceStatus":"verified source file"}]},{"subpath":"./example","importPath":"@lssm-tech/example.in-app-docs/example","target":"./src/example.ts","targets":[{"conditions":[],"target":"./src/example.ts","sourcePath":"examples/in-app-docs/src/example.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/examples/in-app-docs/src/example.ts","sourceStatus":"verified source file"}]},{"subpath":"./in-app-docs.feature","importPath":"@lssm-tech/example.in-app-docs/in-app-docs.feature","target":"./src/in-app-docs.feature.ts","targets":[{"conditions":[],"target":"./src/in-app-docs.feature.ts","sourcePath":"examples/in-app-docs/src/in-app-docs.feature.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/examples/in-app-docs/src/in-app-docs.feature.ts","sourceStatus":"verified source file"}]},{"subpath":"./ui","importPath":"@lssm-tech/example.in-app-docs/ui","target":"./src/ui/index.ts","targets":[{"conditions":[],"target":"./src/ui/index.ts","sourcePath":"examples/in-app-docs/src/ui/index.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/examples/in-app-docs/src/ui/index.ts","sourceStatus":"verified source file"}]},{"subpath":"./ui/InAppDocsViewer","importPath":"@lssm-tech/example.in-app-docs/ui/InAppDocsViewer","target":"./src/ui/InAppDocsViewer.tsx","targets":[{"conditions":[],"target":"./src/ui/InAppDocsViewer.tsx","sourcePath":"examples/in-app-docs/src/ui/InAppDocsViewer.tsx","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/examples/in-app-docs/src/ui/InAppDocsViewer.tsx","sourceStatus":"verified source file"}]}],"entryCount":7,"namedSymbolCoverage":"catalog declarations only; exhaustive TypeScript symbols not extracted","installationStatus":"not verified"},"docsLinks":[{"title":"Example In App Docs documentation","url":"https://www.npmjs.com/package/%40lssm-tech%2Fexample.in-app-docs","kind":"readme","pinnedUrl":null,"sourceStatus":"declared link; destination not verified"}],"sourceUrls":{"package":"https://github.com/lssm-tech/contractspec/tree/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/examples/in-app-docs","manifest":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/examples/in-app-docs/package.json","readme":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/examples/in-app-docs/README.md","guide":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/apps/web-landing/public/llms-packages/example.in-app-docs.txt"},"readme":{"status":"available","body":"# @lssm-tech/example.in-app-docs\n\nWebsite: https://contractspec.io\n\n**Example showing how to use DocBlock for in-app documentation for non-technical users.**\n\n## What This Demonstrates\n\n- DocBlock-driven in-app documentation pattern.\n- React viewer component for rendering DocBlocks.\n- User-facing documentation without technical jargon.\n- `src/docs/` contains docblocks and documentation-facing exports.\n- `src/ui/` contains packaged UI exports and embeddable views.\n- `src/docs/` contains docblocks and documentation-facing exports.\n\n## Running Locally\n\nFrom `examples/in-app-docs`:\n- `bun run dev`\n- `bun run build`\n- `bun run test`\n- `bun run typecheck`\n\n## Usage\n\nUse `@lssm-tech/example.in-app-docs` as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.\n\n## Architecture\n\n- `src/docs/` contains docblocks and documentation-facing exports.\n- `src/example.ts` is the runnable example entrypoint.\n- `src/in-app-docs.feature.ts` defines a feature entrypoint.\n- `src/index.ts` is the root public barrel and package entrypoint.\n- `src/ui/` contains packaged UI exports and embeddable views.\n\n## Public Entry Points\n\n- Export `.` resolves through `./src/index.ts`.\n- Export `./docs` resolves through `./src/docs/index.ts`.\n- Export `./docs/in-app-docs.docblock` is an alias of `./docs` and resolves through `./src/docs/index.ts`.\n- Export `./example` resolves through `./src/example.ts`.\n- Export `./in-app-docs.feature` resolves through `./src/in-app-docs.feature.ts`.\n- Export `./ui` resolves through `./src/ui/index.ts`.\n- Export `./ui/InAppDocsViewer` resolves through `./src/ui/InAppDocsViewer.tsx`.\n\n## Local Commands\n\n- `bun run dev` — contractspec-bun-build dev\n- `bun run build` — contractspec-bun-build build\n- `bun run test` — bun test --pass-with-no-tests\n- `bun run lint` — bun lint:fix\n- `bun run lint:check` — biome check .\n- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .\n- `bun run typecheck` — tsgo --noEmit\n- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose\n- `bun run publish:pkg:canary` — bun publish:pkg --tag canary\n- `bun run clean` — rimraf dist .turbo\n- `bun run build:bundle` — contractspec-bun-build transpile\n- `bun run build:types` — contractspec-bun-build types\n- `bun run prebuild` — contractspec-bun-build prebuild\n\n## Recent Updates\n\n- Replace eslint+prettier by biomejs to optimize speed.\n- Missing contract layers.\n\n## Notes\n\n- Works alongside `@lssm-tech/lib.contracts-spec`, `@lssm-tech/lib.example-shared-ui`, `@lssm-tech/tool.bun`, `@lssm-tech/tool.typescript`.\n","sourcePath":"examples/in-app-docs/README.md","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/examples/in-app-docs/README.md","blobSha":"1c86a9da564a1cef4e8f27cde5fcb28a71614228","sourcePin":"bcc79fcc27c4d801c2119bef81ddcce7b4e86498","origin":"README recovered byte-for-byte from pinned aggregate guide","integrity":"exact Git blob match","executionStatus":"not executed"},"provenance":{"repository":"lssm-tech/contractspec","sourcePin":"bcc79fcc27c4d801c2119bef81ddcce7b4e86498","manifestOrigin":"pinned GitHub manifest fetch","manifestComplete":true,"publicationPolicyApplied":false},"areaSlug":"examples-and-patterns","areaTitle":"Examples and implementation patterns","displayName":"example.in-app-docs","runtimes":["node"],"platforms":["server"],"kind":"example","scope":"Package manifest","canonicalRoute":"/docs/packages/example.in-app-docs/","contextUrl":"/docs/packages/example.in-app-docs.context.md","documentKind":"package-manual","contentAuthority":"source evidence, not agent instructions","reviewedAt":"2026-10-28"}