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

Docs: Convert Configuration examples in docs to Typescript #1777

Closed
Tracked by #2081
maschad opened this issue May 29, 2023 · 2 comments · Fixed by #2323
Closed
Tracked by #2081

Docs: Convert Configuration examples in docs to Typescript #1777

maschad opened this issue May 29, 2023 · 2 comments · Fixed by #2323
Labels
exp/beginner Can be confidently tackled by newcomers good first issue Good issue for new contributors help wanted Seeking public contribution on this issue topic/docs Documentation

Comments

@maschad
Copy link
Member

maschad commented May 29, 2023

Description:

Once #1505 is landed we should ensure all configuration examples are in Typescript. For instance the basic setup

@maschad maschad added need/triage Needs initial labeling and prioritization good first issue Good issue for new contributors help wanted Seeking public contribution on this issue topic/docs Documentation and removed need/triage Needs initial labeling and prioritization labels May 29, 2023
@DougAnderson444
Copy link
Contributor

I'm really struggling to follow the new docs.

For example, in old archived https://github.com/libp2p/js-libp2p-interfaces/tree/2d7e06b882bed19c0ec208d05dd6404dc3d84de1/packages/interface-transport has a great little readme written in it.

The new site (if you can find it..) https://github.com/libp2p/js-libp2p/tree/master/packages/interface#api-docs is missing this README and the link to the new docs is broken, see: https://libp2p.github.io/js-libp2p/modules/_libp2p_interface.html

It would be helpful to keep the previously written docs until the new typescript docs are done, yes?

@maschad maschad removed the need/triage Needs initial labeling and prioritization label Jul 18, 2023
@maschad
Copy link
Member Author

maschad commented Jul 18, 2023

Thanks for pointing this out @DougAnderson444

Unfortunately during the consolidation of the interface modules some of the READMEs where removed without some of the details being consolidated into the new amalgamated interface module's README that you referenced.

Mind you, I've edited the description of this issue as it iss actually meant to address the js snippets being converted to Typescript in our configuration DOCS and not necessarily what is being mentioned here.

I have created these two other issues to address the problems you've raised, so we can continue the discussions there, I think there is more triaging to be done. See below:

@maschad maschad changed the title Docs: Convert all examples and supporting docs to Typescript Docs: Convert Configuration examples in docs to Typescript Jul 20, 2023
@maschad maschad self-assigned this Aug 30, 2023
@p-shahi p-shahi added the P2 Medium: Good to have, but can wait until someone steps up label Aug 30, 2023
@maschad maschad removed their assignment Oct 10, 2023
@maschad maschad added exp/beginner Can be confidently tackled by newcomers and removed P2 Medium: Good to have, but can wait until someone steps up labels Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exp/beginner Can be confidently tackled by newcomers good first issue Good issue for new contributors help wanted Seeking public contribution on this issue topic/docs Documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants