Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Config file docs #2204

Closed
vasco-santos opened this issue Jun 27, 2019 · 2 comments · Fixed by #2256
Closed

Config file docs #2204

vasco-santos opened this issue Jun 27, 2019 · 2 comments · Fixed by #2256
Labels
help wanted Seeking public contribution on this issue status/ready Ready to be worked topic/docs Documentation

Comments

@vasco-santos
Copy link
Member

  • Version: N/A
  • Platform: N/A
  • Subsystem: Documentation

Type: Enhancement

Description:

Same way as go-ipfs does ipfs/go-ipfs/master/docs/config.md, js-ipfs should have a documentation section for the config file, or at least point to a place where it is documented. There is some information on ipfs/js-ipfs#optionsconfig, but we do not document which type of values each configuration property can have, as well as what is the purpose of each one.
@vasco-santos vasco-santos added help wanted Seeking public contribution on this issue status/ready Ready to be worked labels Jun 27, 2019
@vasco-santos vasco-santos mentioned this issue Jun 27, 2019
Closed
3 tasks
@alanshaw alanshaw added the topic/docs Documentation label Jul 10, 2019
@alanshaw
Copy link
Member

Any chance you'd like to take a stab at this @vasco-santos? 😉 😘

@vasco-santos
Copy link
Member Author

I may be able to have that time for you next week!

@vasco-santos vasco-santos mentioned this issue Jul 15, 2019
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
help wanted Seeking public contribution on this issue status/ready Ready to be worked topic/docs Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: add config file ipfs/js-ipfs
2 participants
@alanshaw @vasco-santos