Skip to content

Commit 50efa86

Browse files
authored
Merge pull request #6 from traceroot-ai/zecheng_fix_pre_commit_readme_improve_chat_ui
Fix pre-commit, README and improve chat UI
2 parents 53f3d16 + da16ea4 commit 50efa86

File tree

3 files changed

+48
-23
lines changed

3 files changed

+48
-23
lines changed

.github/workflows/pre-commit.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,5 @@ jobs:
3434
3535
- name: Run pre-commit
3636
run: |
37-
pre-commit run --all-files
37+
SKIP=no-commit-to-branch pre-commit run --all-files
3838
shell: bash

README.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,28 @@ We are a community-driven collective comprising over multiple engineers and rese
8989
</tr>
9090
</table>
9191

92+
## AI Agent Framework
93+
94+
Here is an overview for our AI Agent Framework:
95+
96+
### Context Model
97+
98+
<div align="center">
99+
<a href="https://traceroot.ai/">
100+
<img src="misc/images/agent-context.svg" alt="Context Model" width="80%">
101+
</a>
102+
</div>
103+
104+
### Chunking
105+
106+
TODO: Add TraceRoot's specialized chunking.
107+
108+
### Explainability
109+
110+
TODO: Add TraceRoot's specialized explainability.
111+
112+
Please checkout the [README.md in the `rest/agent` directory](rest/agent/README.md) for more details.
113+
92114
## Installation
93115

94116
You can install the latest version of TraceRoot with the following command:
@@ -107,6 +129,8 @@ pip install -e .
107129

108130
## Local Usage
109131

132+
For local usage, all of your data will be stored locally.
133+
110134
You can use the TraceRoot framework locally by following the [README.md in the `ui` directory](ui/README.md) and [README.md in the `rest` directory](rest/README.md).
111135

112136
Also, you can build the latest docker image and run the docker container by following the [README.md in the `docker` directory](docker/public/README.md).
@@ -133,6 +157,9 @@ docker run -d --name jaeger \
133157
cr.jaegertracing.io/jaegertracing/jaeger:2.8.0
134158
```
135159

160+
In local mode, the first step is to go to the integration page and connect with your GitHub account (optional) with your GitHub token.
161+
You also need to put your OpenAI API key in the integration page.
162+
136163
## SDK
137164

138165
Our platform is built on top of the TraceRoot SDK. You need to use our SDK to integrate with your applications by
@@ -155,28 +182,6 @@ As mentioned above, you need to setup the Jaeger docker container at first befor
155182
156183
For more details or the SDK usage and examples, please checkout this [Quickstart](https://docs.traceroot.ai/quickstart).
157184
158-
## AI Agent Framework
159-
160-
Here is an overview for our AI Agent Framework:
161-
162-
### Context Model
163-
164-
<div align="center">
165-
<a href="https://traceroot.ai/">
166-
<img src="misc/images/agent-context.svg" alt="Context Model" width="80%">
167-
</a>
168-
</div>
169-
170-
### Chunking
171-
172-
TODO: Add TraceRoot's specialized chunking.
173-
174-
### Explainability
175-
176-
TODO: Add TraceRoot's specialized explainability.
177-
178-
Please checkout the [README.md in the `rest/agent` directory](rest/agent/README.md) for more details.
179-
180185
## Citation
181186
182187
If you find TraceRoot useful in your research, please consider citing:

ui/src/components/right-panel/agent/ChatMessage.tsx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,26 @@ const renderMarkdown = (text: string, messageId: string, references?: Reference[
144144
);
145145
}
146146
},
147+
// Standard markdown link pattern - [text](url)
148+
{
149+
regex: /\[([^\]]+)\]\(([^)]+)\)/g,
150+
component: (match: string, ...args: string[]) => {
151+
const [linkText, url] = args;
152+
153+
return (
154+
<a
155+
key={currentIndex++}
156+
href={url}
157+
target="_blank"
158+
rel="noopener noreferrer"
159+
className="text-black dark:text-white hover:text-gray-600 dark:hover:text-gray-300 underline font-medium transition-colors"
160+
title={linkText}
161+
>
162+
{linkText}
163+
</a>
164+
);
165+
}
166+
},
147167
// Reference numbers pattern - must come before log level patterns
148168
{ regex: /\[(\d+)\]/g, component: (match: string, ...args: string[]) => {
149169
const refNumber = parseInt(args[0]);

0 commit comments

Comments
 (0)