Skip to content

Commit ebc8fde

Browse files
committed
Polish app preview metadata and onboarding
1 parent 35362bd commit ebc8fde

2 files changed

Lines changed: 25 additions & 2 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
55
[![Live App](https://img.shields.io/badge/Live%20App-Streamlit-2563eb?logo=streamlit&logoColor=white)](https://portfolio-reviewer-agent.streamlit.app)
66

7-
GitHub Portfolio Reviewer Agent is a Streamlit app that audits a GitHub profile or a selected set of repositories and turns the result into a recruiter-facing report.
7+
GitHub Portfolio Reviewer Agent is a Streamlit app that audits GitHub repositories and profiles, scores portfolio quality, and generates recruiter-facing improvement reports.
88

99
Live app: [portfolio-reviewer-agent.streamlit.app](https://portfolio-reviewer-agent.streamlit.app)
1010

app.py

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -767,6 +767,23 @@ def _render_intro():
767767
)
768768

769769

770+
def _render_how_it_works():
771+
with st.expander("How it works"):
772+
st.markdown(
773+
textwrap.dedent(
774+
"""
775+
1. Sign in with GitHub or enter a public GitHub username.
776+
2. Load repositories from that profile.
777+
3. Choose `Single repository`, `Selected repositories`, or `Portfolio slice`.
778+
4. Run the analysis to generate scored, recruiter-facing feedback.
779+
5. Export the result as Markdown or PDF.
780+
781+
Use `Force refresh analysis` when you want to bypass the saved cache and regenerate the report.
782+
"""
783+
).strip()
784+
)
785+
786+
770787
def _render_metric_card(label, value, note, label_badge=None, emphasize=False):
771788
badge_html = ""
772789
if label_badge:
@@ -1404,14 +1421,20 @@ def _render_downloads(report, github_username):
14041421

14051422

14061423
def main():
1407-
st.set_page_config(page_title="GitHub Portfolio Reviewer", page_icon="GitHub")
1424+
st.set_page_config(
1425+
page_title="GitHub Portfolio Reviewer",
1426+
page_icon="🤖",
1427+
layout="wide",
1428+
initial_sidebar_state="collapsed",
1429+
)
14081430
_inject_styles()
14091431
_init_auth_state()
14101432
try:
14111433
_handle_github_oauth_callback()
14121434
except Exception as error:
14131435
st.session_state.github_auth_error = _error_message(error)
14141436
_render_intro()
1437+
_render_how_it_works()
14151438
_render_auth_panel()
14161439

14171440
with st.form("repo_catalog_form", clear_on_submit=False):

0 commit comments

Comments
 (0)