Skip to content

Commit

Permalink
doc: fix headings in markdown files
Browse files Browse the repository at this point in the history
First (and only) H1 heading is the title and subsequent headings should
not skip levels (e.g., from H2 to H4).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
  • Loading branch information
dbkinder committed Jul 28, 2024
1 parent a2437e8 commit d32731a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions DocSum/docker/ui/react/README.md
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
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)

0 comments on commit d32731a

Please sign in to comment.