How it works?

Using Guthub Wiki, we cannot open Pull Requests to have approvals and reviews.

This workflow will automatically sync the docs/ dir into the wiki repo. Do not forget to set the repo to never commit to master and only after PR merge, the action to sync will start.

1. Add or modify files inside docs/ directory. Files must be in Markdown format (.md extension)
2. Push your branch
3. Open a Pull Request
4. Wait for approval
5. Merge your branch into main

The Github Action will be in charge of syncing the added/changed files into the wiki page.

Attention:

• Files out of docs directory will not be synced
• Push to the main branch is not allowed and it must be done via Pull Requests
• The PR must be approved at least by one team member

Q: Why don't we pull the wiki repo and change files there?
A: Doing so we cannot keep tracking of changes and we cannot have approvals via PRs.