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

Syncing config and experimental-features docs #9182

Open
3 tasks done
aschmahmann opened this issue Aug 11, 2022 · 0 comments
Open
3 tasks done

Syncing config and experimental-features docs #9182

aschmahmann opened this issue Aug 11, 2022 · 0 comments
Labels
kind/enhancement A net-new feature or improvement to an existing feature

Comments

@aschmahmann
Copy link
Contributor

Checklist

  • My issue is specific & actionable.
  • I am not suggesting a protocol enhancement.
  • I have searched on the issue tracker for my issue.

Description

We currently have config.md and [experimental-features.md] https://github.com/ipfs/kubo/blob/master/docs/experimental-features.md. However, not all of the experimental features that are configurable from the config file are listed in config.md, and some of the experimental options in config.md are not listed in experimental-features.md.

This makes discovery of experimental feature more painful than it needs to be and users end up needing to check both places.

#9181 was a bandaid to make this more reasonable, but these documents should be refactored to be consistent.

@aschmahmann aschmahmann added the kind/enhancement A net-new feature or improvement to an existing feature label Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement A net-new feature or improvement to an existing feature
Projects
None yet
Development

No branches or pull requests

1 participant