Improving the docs/ repo

krtaylor kurt.r.taylor at gmail.com
Thu Oct 24 00:51:42 AEDT 2019


On 10/22/19 11:38 AM, Gunnar Mills wrote:
> Looking to improve the docs/ repository.
> Is anyone interested in getting involved in improving the document 
> repository? Looking for either ideas or contributions.
> 
> Some ideas:
> Better document the process for submitting documents which should 
> improve the quality of documentation being submitted.
> 
> Design template improvement, spell out any additional expectations that 
> come in review. E.g. All fields must be filled out, involve the 
> community before submitting a template, avoid internal acronyms, expand 
> on when the template is needed.

Love this - I'll help as I can. I'd like to see TSC and maintainer 
agreement of more strict guidelines.

> Improve the glossary

We can add the BMC terms that I started, now where did I put that...

Kurt Taylor (krtaylor)

> 
> Some automation, check for dead links, markdown formatted is available 
> for the reviewer.
> 
> Improve the layout of the docs/ repo.
> 
> Improve the README, have a well laid out starting point.





More information about the openbmc mailing list