From 21fab71f6d83b73fff85b627826fa25832f2c660 Mon Sep 17 00:00:00 2001 From: David Kinder Date: Tue, 30 Jul 2024 08:55:30 -0700 Subject: [PATCH] doc: fix headings in markdown files (#470) 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 --- DocSum/docker/ui/react/README.md | 8 ++++---- DocSum/docker/xeon/README.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/DocSum/docker/ui/react/README.md b/DocSum/docker/ui/react/README.md index 819469e73..2d6037e1f 100644 --- a/DocSum/docker/ui/react/README.md +++ b/DocSum/docker/ui/react/README.md @@ -1,12 +1,12 @@ -

Doc Summary React

+# 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) -

🧐 Features

+## 🧐 Features Here're some of the project's features: @@ -14,7 +14,7 @@ Here're some of the project's features: - 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. -

🛠️ Get it Running:

+## 🛠️ Get it Running 1. Clone the repo. diff --git a/DocSum/docker/xeon/README.md b/DocSum/docker/xeon/README.md index 56bba3bfe..e17e8ce17 100644 --- a/DocSum/docker/xeon/README.md +++ b/DocSum/docker/xeon/README.md @@ -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)