Skip to content

Commit

Permalink
Rewrite documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MattiSG committed Dec 6, 2022
2 parents afe1056 + e8e78d5 commit 40687db
Show file tree
Hide file tree
Showing 27 changed files with 1,015 additions and 388 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Expand Up @@ -5,7 +5,11 @@ All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and the format is based on [Common Changelog](https://common-changelog.org).\
Unlike Common Changelog, the `unreleased` section of [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) is preserved with the addition of a tag to specify which type of release should be published and to foster discussions about it inside pull requests. This tag should be one of the names mandated by SemVer, within brackets: `[patch]`, `[minor]` or `[major]`. For example: `## Unreleased [minor]`.

## Unreleased
## Unreleased [patch]

### Fixed

- Rewrite documentation to bring it up to date with current behaviour.

## 0.17.0 - 2022-12-06
### Added
Expand Down
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -15,7 +15,7 @@ First of all, thanks for taking the time to contribute! 🎉👍
- [Practices](#practices)
- [Errors handling](#errors-handling)

---
- - -

## Workflow

Expand Down Expand Up @@ -61,6 +61,15 @@ All changes to the codebase that impact users must be documented in the [`CHANGE

### Documentation

#### Copywriting

Avoid “you” and “we” (who is “we” in a common anyway?). Use neutral or passive wordings.

```diff
- You can find federated public instances on GitHub.
+ Federated public instances can be found on GitHub.
```

#### CLI

##### docopt
Expand Down
110 changes: 0 additions & 110 deletions README.fr.md

This file was deleted.

0 comments on commit 40687db

Please sign in to comment.