search

ssbc / ssb-config

standard configuration for ssb
MIT License
23 stars 18 forks source link

Documentation drive #46

Closed elevenpassin closed 4 years ago

elevenpassin commented 5 years ago

WIP Documentation

rate the current state of the documentation out of 10 - 7 is it clear what this is used for? - Yes is there api documentation? - Yes read code, do you see any undocumented methods? - Not as of now. for a method is there any undocumented options? - Yes

dominictarr commented 5 years ago

It helps the person who merges if you can describe what sort of changes you made, it looks like you just changed punctuation and formatting (bold to italic)? the code examples should probably be the same code style as the code - so no ;

but i'd probably just merge this anyway, just checking if there was something you did change other than formatting?

you said: "for a method is there any undocumented options? - Yes" which method had undocumented options?

stale[bot] commented 5 years ago

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

mixmix commented 4 years ago

I've copied new parts out of this PR into the master branch. Thanks for this contribution!