Skip to content
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

doc: fix headings in markdown files #470

Merged
merged 1 commit into from
Jul 30, 2024
Merged

doc: fix headings in markdown files #470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions DocSum/docker/ui/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<h1 align="center" id="title">Doc Summary React</h1>
# Doc Summary React

### 📸 Project Screenshots
## 📸 Project Screenshots

![project-screenshot](../../../assets/img/docsum-ui-react.png)
![project-screenshot](../../../assets/img/docsum-ui-react-file.png)
![project-screenshot](../../../assets/img/docsum-ui-react-error.png)

<h2>🧐 Features</h2>
## 🧐 Features

Here're some of the project's features:

- Summarizing Uploaded Files: Upload files from their local device, then click 'Generate Summary' to summarize the content of the uploaded file. The summary will be displayed on the 'Summary' box.
- Summarizing Text via Pasting: Paste the text to be summarized into the text box, then click 'Generate Summary' to produce a condensed summary of the content, which will be displayed in the 'Summary' box on the right.
- Scroll to Bottom: The summarized content will automatically scroll to the bottom.

<h2>🛠️ Get it Running:</h2>
## 🛠️ Get it Running

1. Clone the repo.

Expand Down
4 changes: 2 additions & 2 deletions DocSum/docker/xeon/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,10 +150,10 @@ export LANGCHAIN_API_KEY=ls_...
Open this URL `http://{host_ip}:5173` in your browser to access the svelte based frontend.
Open this URL `http://{host_ip}:5174` in your browser to access the React based frontend.

#### Svelte UI
### Svelte UI

![project-screenshot](../../assets/img/docSum_ui_text.png)

#### React UI
### React UI

![preject-react-screenshot](../../assets/img/docsum-ui-react.png)