Improving the docs/ repo

Gunnar Mills gmills at linux.vnet.ibm.com
Wed Oct 23 03:38:24 AEDT 2019


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.

Improve the glossary

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