Skip to content

Documentation is not Formatted Correctly(don't copy blindly from wiki) #22

@RituRajSingh878

Description

@RituRajSingh878

I think that all Documentation of aboutcode is very messed up and we should not just copy blindly from wiki and update here. Many of the docs are using an old version of the scancode-toolkit command, So we should take care of that and correct it then only we should push it. By just copying and pasting they look like very messed (the font is also not right, spacing is also not proper)and it will be a problem later because for modification we have to take a look on every page. So I think whenever we are updating doc of aboutcode we should modify it at that instant and then only we should push it.

The second thing is wiki doc is not well defined and are the quick tutorial. During forwarding it from wiki to aboutcode doc, we should take care of this also else this will cause a problem. Later, when we have to do modifications, then all previous work will be useless and we have to remove the code.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions