Skip to content

add finess to readme #330

@IvoryC

Description

@IvoryC

There are several common features used on github readme pages to add a level finesse.

We could add a ribbon to our read-the-docs page to lead people to our github project.
https://github.blog/2008-12-19-github-ribbons/
This might also require configuring the hearder in the material theme for mkdocs:
https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/
And/or using this built-in way of linking back to a git repository:
https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/

badges such as 'made with markdown', or read the docs status, github latest release or others.
https://naereen.github.io/badges/

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation; probably relates to the wiki

    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