Skip to content

Documentation improvements #74

Description

@AgathaSorceress
### Improvement steps
- [ ] Outdated GitLab links in README should be replaced
- [ ] A slightly more detailed description of what this project does and how it works should be added at the top of the README
- [ ] The sample configuration could benefit from a short comment that explains what the "server" IP address refers to, to reduce ambiguity
- [ ] The `Pre-commit usage` section (same as in the rest of our projects) should be added to the `Contributing` section of the README
- [ ] Add pre-commit config from rust-project template

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Fields

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions