Configuration reference

[iboss-ptk]

The idea here is to get the config struct documentation at runtime to generate md file that has details

• [x] derive_get_docs
  • [x] get docs from simple struct
  • [x] move test to proper place > example
  • [x] nested struct must be compatible with prev get docs
  • [x] get docs from nested struct
• [x] refactor md gen into its own package so that md package only focus on generating md and use cli and get_docs as deps
• [x] gen README.md
• [x] treat doc strings as cmark structure
• [x] add type information
  • [x] in general
  • [x] take care of optional
  • [x] take care of map
• [x] Brush up description
• [x] rename fn get_docs -> get_data_docs;
• [x] rename crate derive_get_doc -> data_doc_derive, get_docs -> data_doc
• [x] draft the config doc structure
• [x] generate config doc

struct Docs(Vec<Doc>);

struct DataDoc {
  ident: String,
  desc: Vec<String>,
  sub_docs: Vec<DataDoc>
};

trait GetDataDocs {
  get_data_docs() -> Vec<DataDoc>;
}