[Docs] - Add documentation for the codebase
Closed this issue · 4 comments
virajsazzala commented
It's always great to have documentation about the codebase, as it would help new developers and contributors to the project!
It would be great to have a docs/ directory and having documentation neatly structured for the entire repository!
These are the primary files for which documentation is required:
theatre_cli/movie.pytheatre_cli/player.pytheatre_cli/config.pyscripts/theatre-cli
How to structure the docs/ directory? -> It's upto you, just keep it clean!
Also, in addition to this, a brief introduction to rest of the files and the file structure, would be greatly appreciated!
nayanmapara commented
Hey @virajsazzala I would like to work on this.
virajsazzala commented
Yes @nayanmapara, you can get started!
Nitish36 commented
Hey @virajsazzala I would like to work on the documentation part.
virajsazzala commented
Yes @Nitish36! You can get started too