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

Configuration page needs updates #1228

Closed
wemeetagain opened this issue May 26, 2022 · 5 comments · Fixed by #1505
Closed

Configuration page needs updates #1228

wemeetagain opened this issue May 26, 2022 · 5 comments · Fixed by #1505
Assignees
Labels
good first issue Good issue for new contributors help wanted Seeking public contribution on this issue topic/docs Documentation

Comments

@wemeetagain
Copy link
Member

Issues seen while migrating lodestar to latest libp2p:

  • configuration page references peer store "persistence", no longer an option, should use PersistentPeerStore instead
  • persistent: boolean listed in an unused interface in src/index.ts
  • dialer: {...} referenced in configuration page, should instead be under connectionManager
  • ...
@wemeetagain wemeetagain added the need/triage Needs initial labeling and prioritization label May 26, 2022
@achingbrain
Copy link
Member

Hand-written docs do get out of sync from time to time. Would you like to submit a PR that brings everything up to date?

@achingbrain achingbrain added help wanted Seeking public contribution on this issue good first issue Good issue for new contributors need/author-input Needs input from the original author topic/docs Documentation and removed need/triage Needs initial labeling and prioritization labels Jun 24, 2022
@mpetrunic mpetrunic removed the need/author-input Needs input from the original author label Aug 30, 2022
@wemeetagain
Copy link
Member Author

I have a branch in progress. waiting on a fix for bbc/typescript-docs-verifier#22

@BigLep
Copy link
Contributor

BigLep commented Oct 4, 2022

@wemeetagain : we're unblocked here now right?

@wemeetagain
Copy link
Member Author

Yes this is unblocked.
It may be useful to break this work up into separate PRs since there's a lot of changes required.
I can start with doc/CONFIGURATION.md.

@maschad
Copy link
Member

maschad commented Dec 2, 2022

@wemeetagain I have a draft PR here to introduce typescript-docs-verifier to check the configs , I'd be happy to help with updating the config docs if you could point me to the branches you had started on.

Given we will have generated docs once #1455 is closed, I don't think we would need to document some of the internal options and type descriptions.

@achingbrain do you think we should add typescript-docs-verifier as a feature to aegir in order to use it here?

@p-shahi p-shahi moved this from In Progress to Needs Investigation in js-libp2p Dec 6, 2022
@p-shahi p-shahi added this to the Best Effort Track milestone Dec 6, 2022
@p-shahi p-shahi moved this from 🤨Needs Investigation to 🥞Weekly Candidates/Discuss🎙 in js-libp2p Jan 24, 2023
@p-shahi p-shahi assigned maschad and unassigned wemeetagain Jan 24, 2023
@p-shahi p-shahi moved this from 🥞Weekly Candidates/Discuss🎙 to 🏃‍♀️In Progress in js-libp2p Jan 24, 2023
@maschad maschad moved this from 🏃‍♀️In Progress to 🧱Blocked in js-libp2p Feb 7, 2023
@maschad maschad moved this from 🧱Blocked to 🏃‍♀️In Progress in js-libp2p Mar 27, 2023
maschad added a commit to maschad/js-libp2p that referenced this issue Apr 21, 2023
@maschad maschad moved this from 🏃‍♀️In Progress to 🧱Blocked in js-libp2p May 1, 2023
maschad added a commit to maschad/js-libp2p that referenced this issue May 3, 2023
maschad added a commit to maschad/js-libp2p that referenced this issue May 3, 2023
maschad added a commit to maschad/js-libp2p that referenced this issue May 3, 2023
maschad added a commit to maschad/js-libp2p that referenced this issue May 29, 2023
@maschad maschad moved this from 🧱Blocked to 🛠️ Todo in js-libp2p Jun 15, 2023
@maschad maschad moved this from 🛠️ Todo to 🧱Blocked in js-libp2p Jun 15, 2023
maschad added a commit to maschad/js-libp2p that referenced this issue Jun 21, 2023
maschad added a commit to maschad/js-libp2p that referenced this issue Jun 28, 2023
maschad added a commit to maschad/js-libp2p that referenced this issue Jun 28, 2023
@github-project-automation github-project-automation bot moved this from 🧱Blocked to 🎉Done in js-libp2p Jul 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

6 participants