Skip to content

Improve documentation format #404

@simoneb

Description

@simoneb

Prerequisites

  • I have written a descriptive issue title
  • I have searched existing issues to ensure the issue has not already been raised

Issue

I think we should improve the formatting and layout of the readme to better convey how to use the action.

I came across this action which does something similar https://github.com/ahmadnassri/action-dependabot-auto-merge, and I find their documentation to be better structured and more easily readable.

E.g. they have inputs displayed as a table, which looks better, that would be the first thing I'd look into improving. The rest of the readme could also use some TLC as some information is out of date.

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