search

reposense / RepoSense

Contribution analysis tool for Git repositories
https://reposense.org
MIT License
250 stars 153 forks source link

Fix some minor cosmetic issues in docs #2218

Closed damithc closed 6 months ago

damithc commented 6 months ago

Fixes for some minor cosmetic issues I noticed while reading the UG.

You can do a rebase merge for this, as each commit is a separate fix.

Fix some minor cosmetic issues in docs

The documentation site for RepoSense uses the legacy <span> syntax for
defining variables. The example dashboards are also outdated. Moreover, the
word 'Git' has been capitalised wrongly in the docs.

Let's update variables.md to use the proper <variable> syntax instead
of the legacy <span> syntax for defining variables. Also, let's remove
the variables.json file as it is not used. Let's update links of example
dashboards to point to a later version which uses a more recent version of
RepoSense. Lastly, let's fix the 'Git' typos across the docs.
ckcherry23 commented 6 months ago

I'll have to squash merge as "Rebase and merge" is disabled for RepoSense.

damithc commented 6 months ago

I'll have to squash merge as "Rebase and merge" is disabled for RepoSense.

@ckcherry23 I enabled it just now.

ckcherry23 commented 6 months ago

Completed in #2221 to rebase with master instead of merge commits

github-actions[bot] commented 6 months ago

The following links are for previewing this pull request: