Home
Welcome to the refreshVersions wiki!
The wiki is complementary to the following resources:
- The website at https://jmfayard.github.io/refreshVersions/
- The repository at https://github.com/jmfayard/refreshVersions
- The issues at https://github.com/jmfayard/refreshVersions/issues
The purpose of the wiki is to give a lighweight way to collaborate on the documentation when ease of iteration is key.
Things where ease of iteration and collaboration is key belong to the wiki:
- Troubleshooting common errors
- Draft changelog for the unreleased version
- Draft documentation for an unreleased feature
- Draft for articles related to Gradle or refreshVersions
- Short tips and tricks for example Gradle tips and tricks
The wiki is not designed for things that should be triple checked before publishing. For example
- README once published
- Changelog once published
- Main documentation once released, typically the setup page should be triple checked https://jmfayard.github.io/refreshVersions/setup/
- Articles once published
- ...
If you see a broken link on the wiki, the most probable reason is that the draft is article was published elsewhere already:
You can always read the latest available version at -> https://github.com/jmfayard/refreshVersions/wiki
From there you can edit any page... except that the wiki is restricted to collaborators of the project. Contact @jmfayard if you want to help with the documentation.
You can also use git and your favorite editor/IDE to edit the wiki
git clone https://github.com/jmfayard/refreshVersions.wiki.git
Note: an editor or IDE designed for programming will work, but writing is a different beast than programming, so you may want to check the awesome https://obsidian.md/ with the obsidian git plugin