Skip to content

Document the library #10

Description

@viktor-yakubiv

In the ideal world the code should be self-documented. There are couple of rules for it:

  • Do not repeat yourself
  • Every chunk of code should do only one thing
  • Code needs to be split to modules
  • Functions should have proper names

We already follow this all. Although, to extend self-documented idea I would like to suggest the following: the repository should be documented alongside with the code. In other words, imagine: you are browsing the repository and in each directory you find out docs for each component you see.

GitHub helps us with this by README.md files. It's supported natively and is displayed any time you open a directory. I would like to follow that.

Also, I suggest to get rid out from the docs directory in favour of having everything in the src.

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