Skip to content

The formatting of the user guide in the documentation is not correct #447

@vtraag

Description

@vtraag

The user guide / tutorial is currently not formatted correctly. In particular, it requires at least the following changes:

  • Inline code need to be enclosed in two backticks, not a single one.
  • Literal code blocks need to be introduced with a double colon, not a single one
  • Some elements are enclosed in pipes, but should be enclosed in backticks instead.

Possibly there are some additional formatting problems, it needs to be revised throughout.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions