Skip to content

Publish documentation #853

@noirbizarre

Description

@noirbizarre

Describe the feature:

I have been working with goss a lot lately and the lack of formal documentation makes it harder to use than it should, and it makes also harder to accept goss in company project (hard to sell a project when you can't share a documentation)

Would you be open to a pull request moving the markdown documentation to MkDocs, either published on GitHub pages, either published on readthedocs.io ?

I can do it and provides:

  • mkdocs scafolding
  • porting the existing doc into it
  • readthedoc conf or a github workflow to publish it automatically

Describe the solution you'd like
The documentation being properly published somewhere with classical tooling (TOC, search, deep linking...)

Describe alternatives you've considered
There are many, I suggest Mkdocs as I can quickly submit a PR to do that, but any documentation engine would be an improvement on the current situation.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions