You are looking at the user documentation for the most recent master branch of RepoSense (not released to the public yet). The documentation for the latest public release is here.

User guide

Welcome to the RepoSense user guide. This user guide takes you through a three-step approach to adopting RepoSense for your own use.

In case you missed it, the overview of RepoSense is given below.

Report: We use the term report to refer to the web-based visualization generated by RepoSense. You can also think of it as a dashboard.

1 Explore real-life examples

If still not entirely sure if RepoSense matches your needs, you can use the examples of real-life RepoSense reports given below to get some sense of what visualizations it produces.

As you explore the above examples, you can refer to the following section to learn how to read and interact with those reports.

2 Generate your own reports

The next step is to generate your own RepoSense reports, either in your computer, or on one of the remote platforms we support.

As you generate reports, you may need to learn how to customize those reports further.

3 Share your reports

Finally, you can learn how to share those reports with others, and how to automate the whole process.

If you encounter problems at any step, you can refer to our FAQ, the troubleshooting guide, or post in our issue tracker.

Happy RepoSensing!