Skip to content

Documentation Improvement  #5

@luisamarti

Description

@luisamarti

/docs/index.md is where pyzkiln documents all of the package functions.
Currently, everything is documented in a bulleted list format. As the project grows, the documentation format needs to be improved for better readability.

Change index.md documentation format to be more readable and extendable. Some improvement can include adding more anchor links, tables, and sections.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions