diff --git a/docs/README.md b/README.md similarity index 78% rename from docs/README.md rename to README.md index 30112f0..82d4772 100644 --- a/docs/README.md +++ b/README.md @@ -26,15 +26,15 @@ This action comes with sensible defaults to make it **very easy** for you to use - Pull Requests can be created on both SoT and destination - Pull Requests created on destination are always copied by Copybara to SoT -> This is the flow used for this action's [basic usage](basic-usage.md), you can make it whatever you want it to be in [advanced usage](advanced-usage.md). +> This is the flow used for this action's [basic usage](docs/basic-usage.md), you can make it whatever you want it to be in [advanced usage](docs/advanced-usage.md). -## ๐Ÿ”ฅ [Basic usage](basic-usage.md) +## ๐Ÿ”ฅ [Basic usage](docs/basic-usage.md) -## ๐Ÿงจ [Advanced usage](advanced-usage.md) +## ๐Ÿงจ [Advanced usage](docs/advanced-usage.md) -## ๐Ÿ”˜ [All options](inputs.md) +## ๐Ÿ”˜ [All options](docs/inputs.md) -## ๐Ÿ’š [Contributing](CONTRIBUTING.md) +## ๐Ÿ’š [Contributing](docs/CONTRIBUTING.md) ## ๐Ÿ’ฌ Support diff --git a/docs/basic-usage.md b/docs/basic-usage.md index 3105db5..11e349a 100644 --- a/docs/basic-usage.md +++ b/docs/basic-usage.md @@ -1,6 +1,6 @@ # Basic usage -As per the [default flow](README.md#default-flow), Pull Requests **must be merged on the repo that acts as the Source of Truth (SoT)**. They must never be merged on destination! +As per the [default flow](/README.md#default-flow), Pull Requests **must be merged on the repo that acts as the Source of Truth (SoT)**. They must never be merged on destination! Once they are merged on SoT, Copybara will automatically push the code to the destination branch and close the Pull Request that was initially created on destination (if any).