diff --git a/docs/allure_plugin.md b/docs/android-allure-plugin.md similarity index 100% rename from docs/allure_plugin.md rename to docs/android-allure-plugin.md diff --git a/docs/changelog_android_allure.md b/docs/changelog-android-allure.md similarity index 100% rename from docs/changelog_android_allure.md rename to docs/changelog-android-allure.md diff --git a/docs/changelog_junit4_rules.md b/docs/changelog-junit4-rules.md similarity index 100% rename from docs/changelog_junit4_rules.md rename to docs/changelog-junit4-rules.md diff --git a/docs/changelog_reports.md b/docs/changelog-reports.md similarity index 100% rename from docs/changelog_reports.md rename to docs/changelog-reports.md diff --git a/docs/changelog.md b/docs/changelog.md index 9f485489..5e649ed0 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -2,6 +2,6 @@ Libraries: -- [Android Allure Gradle Plugin](changelog_android_allure.md) -- [Test reports](changelog_reports.md) -- [JUnit4 Rules](changelog_junit4_rules.md) +- [Android Allure Gradle Plugin](changelog-android-allure) +- [Test reports](changelog-reports) +- [JUnit4 Rules](changelog-junit4-rules) diff --git a/docs/index.md b/docs/index.md index ba0f15bb..86a67d42 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,7 +20,7 @@ implementation "com.rubensousa.carioca:report-json:{{ report.version }}" implementation "com.rubensousa.carioca:report-runtime:{{ report.version }}" ``` -Jump to [this guide](android_test_reports.md) for how to integrate this library. +Jump to [this guide](test-reports-android) for how to integrate this library. ## License diff --git a/docs/android_test_reports.md b/docs/test-reports-android.md similarity index 99% rename from docs/android_test_reports.md rename to docs/test-reports-android.md index c306843a..71120a92 100644 --- a/docs/android_test_reports.md +++ b/docs/test-reports-android.md @@ -250,6 +250,6 @@ and can be found in `build/outputs/connected_android_test_additional_output/**/c By default, those reports are in json format and are not really easily readable. To visualize them properly, this library ships with an [Allure](https://allurereport.org/) plugin that can be used to generate test reports based on -the metadata collected through each test execution. Check it out in [this page](allure_plugin.md). +the metadata collected through each test execution. Check it out in [this page](android-allure-plugin). diff --git a/mkdocs.yml b/mkdocs.yml index 32cf0db8..7cbef10a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -55,7 +55,7 @@ plugins: nav: - 'Overview': index.md - - 'Android Test Reports': android_test_reports.md - - 'Android Allure Plugin': allure_plugin.md + - 'Android Test Reports': test-reports-android.md + - 'Android Allure Plugin': android-allure-plugin.md - 'Changelog': changelog.md - 'API': api/ \ No newline at end of file