Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: improve description of interfaces and API docs #1424

Closed
Tracked by #1453
weboko opened this issue Jul 10, 2023 · 2 comments
Closed
Tracked by #1453

feat: improve description of interfaces and API docs #1424

weboko opened this issue Jul 10, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@weboko
Copy link
Collaborator

weboko commented Jul 10, 2023

This is a change request

Problem

API docs are not in the best shape and are a bit convoluted - not all properties have description comments.

The project structure on the site is hard to follow:
image

Proposed Solutions

We can add description comments to some of the properties such as defaultBootstrap etc.
Additionally, we can check what can be done to make the project structure there easier to follow.

Notes

Ref: waku-org/docs.waku.org#82 (comment)

@weboko weboko added documentation Improvements or additions to documentation API labels Jul 10, 2023
@fryorcraken fryorcraken removed the API label Jul 31, 2023
@danisharora099
Copy link
Collaborator

find a resolution TypeStrong/typedoc#1835 (comment) and possibly upgrading should fix.
let's keep this issue opened until the original issue is resolved.

@weboko
Copy link
Collaborator Author

weboko commented Sep 21, 2023

Should be resolved now

image

@weboko weboko closed this as completed Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

3 participants