Skip to content

[Feature] Generate API reference for @o2s/framework #755

@tomaszpacior

Description

@tomaszpacior

Is your feature request related to a problem? Please describe.
The framework exports modules, models, and an SDK, but there is no auto-generated API reference for @o2s/framework. Consumers need to inspect source code directly to discover available types, interfaces, and service methods, which slows onboarding and increases integration mistakes.

Describe the solution you'd like
Generate and publish TypeDoc documentation for @o2s/framework as part of the docs workflow. At minimum, provide an index of all module services and their methods (including parameters and return types) so consumers can discover extension points without reading implementation files.

Additional context (if applicable)

  • Phase: 0.5 — Consumer Extension Points
  • Source: high/
  • Related note: this could enable automated descriptions of modules and normalized data models in docs, potentially assisted by AI generation.


This repo is using Opire - what does it mean? 👇
💵 Everyone can add rewards for this issue commenting /reward 100 (replace 100 with the amount).
🕵️‍♂️ If someone starts working on this issue to earn the rewards, they can comment /try to let everyone know!
🙌 And when they open the PR, they can comment /claim #755 either in the PR description or in a PR's comment.

🪙 Also, everyone can tip any user commenting /tip 20 @tomaszpacior (replace 20 with the amount, and @tomaszpacior with the user to tip).

📖 If you want to learn more, check out our documentation.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions