User Guide still including --assets despite deprecation

[yizhong187]

Tell us about your environment

• RepoSense Version:: 4.0
• OS and Version:: MacOS Tahoe Version 26.1

Please include the steps to reproduce the bug.

1. Run ./gradlew run -Dargs="--repos https://github.com/nusmodifications/nusmods.git --assets ./myassets --view".

What was expected to happen?

RepoSense was supposed to have successfully ran with the new given asset path, which would contain the favicon.ico and title.md, allowing the user to customise those settings.

What actually happened? Please include a screenshot of the output.

05:50:53 - [WARNING] usage: java -jar RepoSense.jar [--help] [--version]
                               [--ignore-standalone-config]
                               [--ignore-filesize-limit] [--view [PATH]]
                               [--output PATH] [--since dd/MM/yyyy]
                               [--until dd/MM/yyyy] [--period PERIOD]
                               [--formats [FORMAT [FORMAT ...]]]
                               [--timezone ZONE_ID[±hh[mm]]]
                               [--find-previous-authors]
                               [--analyze-authorship]
                               [--originality-threshold (0.0 ~ 1.0)]
                               [--portfolio] [--text] [--fresh-cloning]
                               [--config PATH |
                               --repo LOCATION [LOCATION ...]]
                               [--last-modified-date | --shallow-cloning]
unrecognized arguments: '--assets'

The above warning was generated and the dashboard did not run automatically after the build completed.

Additional Notes

Issue #2430 is related to the asset file customisation and can be worked on together.

[lyuanww]

Good catch! This appears to be a documentation issue. The asset flag has already been removed in #2315.

[yizhong187]

@lyuanww @CYX22222003 Can I check if the title.md and favicon.ico customisation has been moved into the --config flag or were they deprecated entirely?

[lyuanww]

@yizhong187 Both of them are moved into the config flag.
Refer to: https://reposense.org/ug/customizingReports.html#personalizing-reports

Regarding title.md, it will be replaced by intro.md if #2516 is merged. We plan to deprecate title.md in the next major release.