Skip to content

[#2420] Update User Guide to give more details about the portfolio mode #2486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
CYX22222003 merged 6 commits into from
Aug 14, 2025
Merged

[#2420] Update User Guide to give more details about the portfolio mode #2486

CYX22222003 merged 6 commits into from
Aug 14, 2025
+29 −0

Conversation

@lihongong
Copy link
Contributor

@lihongong lihongong commented Jul 25, 2025

Fixes #2420

Proposed commit message

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.

CYX22222003
CYX22222003 approved these changes Jul 25, 2025
View reviewed changes
Copy link
Member

@CYX22222003 CYX22222003 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Please edit the name of the PR to closely follow the standards.

sopa301
sopa301 requested changes Jul 27, 2025
View reviewed changes
Copy link
Contributor

@sopa301 sopa301 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi lihongong, thanks for your contribution, I just have a few minor comments.

lihongong and others added 4 commits July 29, 2025 22:27
@lihongong
update portfolioMode.md based on reviews
42b9610
@lihongong
Merge branch 'branch-userGuidePortfolioMode' of https://github.com/ws…
c85dbe6 
…wddl/RepoSense into branch-userGuidePortfolioMode

# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.
@lihongong
Remove redundant Key Features comparisons in portfolioMode.md
0557405
@sopa301
Merge branch 'master' into branch-userGuidePortfolioMode
6c95ce9
sopa301
sopa301 approved these changes Aug 7, 2025
View reviewed changes
Copy link
Contributor

@sopa301 sopa301 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@lihongong
Copy link
Contributor Author

lihongong commented Aug 8, 2025

Hi @CYX22222003 @sopa301. I've fix the issues, please review my PR. Thank you.

@CYX22222003 CYX22222003 changed the title Update User Guide to give more details about the portfolio mode [#2420] Update User Guide to give more details about the portfolio mode Aug 8, 2025
@CYX22222003 CYX22222003 merged commit 19384b3 into reposense:master Aug 14, 2025
11 checks passed
@github-actions
Copy link
Contributor

github-actions bot commented Aug 14, 2025

The following links are for previewing this pull request:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sopa301 sopa301 sopa301 approved these changes

@CYX22222003 CYX22222003 CYX22222003 approved these changes

Assignees

No one assigned

Labels

s.ToMerge

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update User Guide to give more details about the portfolio mode

3 participants

@lihongong @sopa301 @CYX22222003