Skip to content

Create a github pages branch and add docs #2

Description

@drkennetz

This will be a multistep process:

  • Create a github pages branch

  • Add documentation explaining the python code architecture: package, utils.py core.py main.py, init.py

  • Add documentation explaining invocation using the bash executable

  • Add documentation explaining what unittests are and the python unittest framework

  • Add documentation explaining what code coverage is and its implementation here

  • Prettify the pages

Activity

  1. xanderyzwich commented on Oct 2, 2020

    @xanderyzwich
    Member

    I'm willing to make the changes if i can interview @drkennetz to get the information.

  2. drkennetz commented on Oct 5, 2020

    @drkennetz
    CollaboratorAuthor

    @xanderyzwich I am good with that.

  3. xanderyzwich commented on Oct 6, 2020

    @xanderyzwich
    Member

    note found elsewhere:

    To add subpages, simply create a new folder on GitHub and add an "index.html" file into that folder.

  4. self-assigned this
    on Oct 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationhacktoberfestissues good for hacktoberfest

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions