Open frank-zsy opened 1 year ago
This issue has not been replied for 24 hours, please pay attention to this issue: @gymgym1212 @xiaoya-yaya @xgdyp
I think we should modify the structure of the doc, CHAOSS metric docs could be used as reference.
Description
section about what the metric is aboutObjectives
section to show what if the metric for and how to use itData
section about how to retrieve the data and the data structureImplementation
section rather than Code
to add details about the implementation like code
, note
and parameters
WDYT, @xiaoya-yaya @xgdyp
Agreed. Should we apply this structure to all the metrics, each as an exclusive page?
Agreed. Should we apply this structure to all the metrics, each as an exclusive page?
I think so, we could updated the exist pages first to see whether this is good enough, change structure when all the docs finished will be lots of work.
Description
As xiaoya opened the issue #1180 , and I add an example page in OpenDigger website for OpenRank index.
We can add more docs about the metrics and indices we implemented in OpenDigger. The page content should contain:
All the CodePen demos are in the README file. We can embed them in the page directly with editable mode enabled.