Skip to content

Commit 19384b3

Browse files
authored
[#2420] Update User Guide to give more details about the portfolio mode (#2486)
Add PortfolioMode.md to describe portfolio UI differences Previously, the protfolio mode is only described on `cli.md` and lack details. Add a new PortfolioMode.md to explain the purpose and UI effects of the --portfolio flag. I also add related screenshots for documentation.
1 parent 48cc535 commit 19384b3

6 files changed

+29
-0
lines changed
161 KB
Loading
168 KB
Loading
155 KB
Loading
159 KB
Loading

docs/ug/cli.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,9 @@ credit is given.
220220
* Default: generates the regular report
221221
* Alias: `-P` (uppercase P)
222222
* Example: `--portfolio` or `-P`
223+
* **Portfolio Mode** simplifies the dashboard for showcasing individual contributions (e.g., personal portfolio websites, resume links).
223224

225+
See [Portfolio Mode UI](portfolioMode.md) for details on the differences.
224226
<!-- ------------------------------------------------------------------------------------------------------ -->
225227

226228
### `--repo`, `--repos`, `-r`

docs/ug/portfolioMode.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Portfolio Mode UI
2+
3+
Portfolio Mode is designed to provide a clean and minimalistic overview of a contributor's work. It is intended for showcasing individual contributions in personal portfolios, resumes, or public demos.
4+
5+
### When to use Portfolio Mode?
6+
Use Portfolio Mode when you want to present:
7+
- Your contribution timeline and work summary cleanly.
8+
- A version of the dashboard suited for personal portfolios.
9+
10+
### Key Features:
11+
| Feature | Normal Mode | Portfolio Mode
12+
|-------------------------------|-------------------------------------------------------------|--------------------------------|
13+
| Filters | Allow searches, grouping and time period selection | Simplified filters, non-essential toggles are hidden. |
14+
| Visual Focus | Code review and auditing. | Visual summary of personal contributions (clean & minimal) |
15+
| Intended Use | Code analysis and detailed review. | Personal portfolio showcase, resume link, project website. |
16+
17+
18+
### UI Comparison:
19+
| Normal Mode (Default) | Portfolio Mode (`--portfolio`) |
20+
|---------------------------------------------------|------------------------------------------------------------|
21+
| ![Normal Mode Contributions Screenshot](../images/reposense-normal-mode-author-contributions.png) | ![Portfolio Mode Contributions Screenshot](../images/reposense-portfolio-mode-author-contributions.png) |
22+
| ![Normal Mode Commits Screenshot](../images/reposense-normal-mode-author-commits.png) | ![Portfolio Mode Commits Screenshot](../images/reposense-portfolio-mode-author-commits.png) |
23+
24+
---
25+
26+
### Notes
27+
- You can still use other CLI flags (e.g. `--since`, `--until`) in combination with `--portfolio`.

0 commit comments

Comments
 (0)