Skip to content

Update SDK section #12

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

Activity

  1. self-assigned this
    on Jul 11, 2023
  2. moved this to Todo in Roadmapon Aug 14, 2023
  3. moved this from Todo to In Progress in Roadmapon Aug 16, 2023
  4. moved this from In Progress to Done in Roadmapon Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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