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(iroh): Update discovery docs, mostly StaticProvider #3109

Merged
merged 3 commits into from
Jan 13, 2025

Conversation

flub
Copy link
Contributor

@flub flub commented Jan 8, 2025

Description

Updates a bunch of docs around StaticProvider and links from the right places.

This also removes the ability to build docs without using --all-features. The conditionals made things build but are not correct, items that should be documented on docs.rs were not. This goes back to the simpler solution and documents for everyone how they should build docs.

Breaking Changes

Notes & open questions

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

@flub flub requested a review from dignifiedquire January 8, 2025 17:43
Copy link

github-actions bot commented Jan 8, 2025

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/3109/docs/iroh/

Last updated: 2025-01-13T11:02:56Z

@flub flub force-pushed the flub/discovery-clone branch from 5af139d to 07de2c8 Compare January 8, 2025 17:45
@flub flub force-pushed the flub/discovery-docs branch from b015d55 to 101a8d3 Compare January 8, 2025 17:46
@flub flub requested a review from a team January 8, 2025 17:55
Copy link

github-actions bot commented Jan 8, 2025

Netsim report & logs for this PR have been generated and is available at: LOGS
This report will remain available for 3 days.

Last updated for commit: 3a6919b

@flub flub self-assigned this Jan 9, 2025
Base automatically changed from flub/discovery-clone to main January 13, 2025 10:57
@flub flub enabled auto-merge January 13, 2025 10:58
flub added 3 commits January 13, 2025 12:00
Updates a bunch of docs around StaticProvider and links from the right
places.

This also removes the ability to build docs without using
--all-features.  The conditionals made things build but are not
correct, items that should be documented on docs.rs were not.  This
goes back to the simpler solution and documents for everyone how they
should build docs.
@flub flub force-pushed the flub/discovery-docs branch from a6bdf93 to dbd0221 Compare January 13, 2025 11:00
@flub flub added this pull request to the merge queue Jan 13, 2025
Merged via the queue into main with commit eb90bfc Jan 13, 2025
26 checks passed
@flub flub deleted the flub/discovery-docs branch January 13, 2025 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants