Skip to content

Update SDK section #12

@LucJosin

Description

@LucJosin

Description

Update get-sdks script to support a new sdk docs structure.

Doc generators:

  • TypeDoc (Typescript)
  • JavaDoc (Java)
  • GoDoc (Golang)
  • DartDoc (Dart)

HawAPI Docs: /docs/sdks/<sdk-name>/sdkdocs/<sdk-specific-generated-doc>/...

E.g (JavaDoc): /docs/sdks/java-sdk/sdkdocs/javadoc/apidocs/...
E.g (TypeDoc): /docs/sdks/java-sdk/sdkdocs/modules/...

.
├── docs
│   ├── README.md
│   └── /sdkdocs
│       ├── ...
  • README.md - Markdown documentation with sdk showcase. Integrated with retype generated files
  • /sdkdocs - All specific language doc generated files

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