Skip to content

Commit 7d1c2ad

Browse files
committed
chore: rename all internal references from sovd_web_ui to ros2_medkit_web_ui
Update package.json name and repository URL, README badges and text, CONTRIBUTING.md, SECURITY.md, issue/PR templates, copilot instructions, CI workflow Docker tag, and Zustand localStorage key. Closes #41
1 parent eb85ccd commit 7d1c2ad

10 files changed

Lines changed: 98 additions & 56 deletions

File tree

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ What actually happened, including any error messages or stack traces.
2626

2727
### Environment
2828

29-
- sovd_web_ui version:
29+
- ros2_medkit_web_ui version:
3030
- Browser:
3131
- OS:
3232

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Pull Request
22

3-
<!-- Thanks for contributing to sovd_web_ui! -->
3+
<!-- Thanks for contributing to ros2_medkit_web_ui! -->
44

55
## Summary
66

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ export const useAppStore = create<AppState>()(
8787
/* ... */
8888
},
8989
}),
90-
{ name: 'sovd_web_ui_server_url', partialize: (state) => ({ serverUrl, baseEndpoint }) }
90+
{ name: 'ros2_medkit_web_ui_server_url', partialize: (state) => ({ serverUrl, baseEndpoint }) }
9191
)
9292
);
9393
```

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ jobs:
5151
uses: docker/setup-buildx-action@v3
5252

5353
- name: Build Docker image
54-
run: docker build -t sovd-web-ui:test -f Dockerfile .
54+
run: docker build -t ros2-medkit-web-ui:test -f Dockerfile .

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
# Contributing to sovd_web_ui
1+
# Contributing to ros2_medkit_web_ui
22

3-
Thanks for your interest in contributing to sovd_web_ui! This guide explains how to report issues, suggest features, and contribute code.
3+
Thanks for your interest in contributing to ros2_medkit_web_ui! This guide explains how to report issues, suggest features, and contribute code.
44

55
## How to Report Issues
66

77
### Did you find a bug?
88

9-
- **Ensure the bug was not already reported** by searching [Issues](https://github.com/selfpatch/sovd_web_ui/issues)
10-
- If you can't find an existing issue, [open a new one](https://github.com/selfpatch/sovd_web_ui/issues/new/choose) and select the **Bug report** template
9+
- **Ensure the bug was not already reported** by searching [Issues](https://github.com/selfpatch/ros2_medkit_web_ui/issues)
10+
- If you can't find an existing issue, [open a new one](https://github.com/selfpatch/ros2_medkit_web_ui/issues/new/choose) and select the **Bug report** template
1111
- Fill in all sections of the template:
1212
- **Steps to reproduce** - numbered steps to recreate the issue
1313
- **Expected behavior** - what you expected to happen
1414
- **Actual behavior** - what actually happened, including error messages or stack traces
15-
- **Environment** - sovd_web_ui version, browser, OS
15+
- **Environment** - ros2_medkit_web_ui version, browser, OS
1616
- **Additional information** - logs, snippets, or screenshots if helpful
1717

1818
### Do you want to suggest a feature or improvement?
1919

20-
- Check if the feature has already been suggested in [Issues](https://github.com/selfpatch/sovd_web_ui/issues)
21-
- If not, [open a new issue](https://github.com/selfpatch/sovd_web_ui/issues/new/choose) and select the **Feature request / General issue** template
20+
- Check if the feature has already been suggested in [Issues](https://github.com/selfpatch/ros2_medkit_web_ui/issues)
21+
- If not, [open a new issue](https://github.com/selfpatch/ros2_medkit_web_ui/issues/new/choose) and select the **Feature request / General issue** template
2222
- Fill in all sections:
2323
- **Proposal** - describe the change or feature you'd like to see
2424
- **Motivation** - why is this important? Who does it benefit?
@@ -115,18 +115,18 @@ Before submitting your PR, ensure:
115115
116116
## Questions and Help
117117
118-
- For questions about **using sovd_web_ui**, open a [Discussion](https://github.com/selfpatch/sovd_web_ui/discussions) or an Issue with the question label
118+
- For questions about **using ros2_medkit_web_ui**, open a [Discussion](https://github.com/selfpatch/ros2_medkit_web_ui/discussions) or an Issue with the question label
119119
- For questions about **contributing**, feel free to ask in your PR or Issue
120120
- For **security vulnerabilities**, see [`SECURITY.md`](SECURITY.md)
121121
122122
## Code of Conduct
123123
124-
By contributing to sovd_web_ui, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please be respectful and considerate in all interactions.
124+
By contributing to ros2_medkit_web_ui, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please be respectful and considerate in all interactions.
125125
126126
## License
127127
128-
By contributing to sovd_web_ui, you agree that your contributions will be licensed under the Apache License 2.0.
128+
By contributing to ros2_medkit_web_ui, you agree that your contributions will be licensed under the Apache License 2.0.
129129
130130
---
131131
132-
Thank you for improving sovd_web_ui! We value contributions of all sizes - from typo fixes to major features. 🚀
132+
Thank you for improving ros2_medkit_web_ui! We value contributions of all sizes - from typo fixes to major features. 🚀

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# sovd_web_ui
1+
# ros2_medkit_web_ui
22

3-
[![CI](https://github.com/selfpatch/sovd_web_ui/actions/workflows/ci.yml/badge.svg)](https://github.com/selfpatch/sovd_web_ui/actions/workflows/ci.yml)
4-
[![GHCR](https://img.shields.io/badge/GHCR-ghcr.io%2Fselfpatch%2Fsovd__web__ui-blue?logo=github)](https://github.com/selfpatch/sovd_web_ui/pkgs/container/sovd_web_ui)
3+
[![CI](https://github.com/selfpatch/ros2_medkit_web_ui/actions/workflows/ci.yml/badge.svg)](https://github.com/selfpatch/ros2_medkit_web_ui/actions/workflows/ci.yml)
4+
[![GHCR](https://img.shields.io/badge/GHCR-ghcr.io%2Fselfpatch%2Fros2__medkit__web__ui-blue?logo=github)](https://github.com/selfpatch/ros2_medkit_web_ui/pkgs/container/ros2_medkit_web_ui)
55
[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://selfpatch.github.io/ros2_medkit/)
66
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
77
[![Discord](https://img.shields.io/badge/Discord-Join%20Us-7289DA?logo=discord&logoColor=white)](https://discord.gg/6CXPMApAyq)
88

99
Simple, open-source web UI for browsing SOVD (Service-Oriented Vehicle Diagnostics) entity trees via discovery endpoints.
1010

11-
## What is sovd_web_ui?
11+
## What is ros2_medkit_web_ui?
1212

13-
sovd_web_ui is a lightweight single-page application that connects to a SOVD server and visualizes the entity hierarchy. It provides:
13+
ros2_medkit_web_ui is a lightweight single-page application that connects to a SOVD server and visualizes the entity hierarchy. It provides:
1414

1515
- **Server Connection Dialog** - Enter the URL of your SOVD server (supports both `http://ip:port` and `ip:port` formats)
1616
- **Entity Tree Sidebar** - Browse the hierarchical structure of SOVD entities with lazy-loading
@@ -38,12 +38,12 @@ This tool is designed for developers and integrators working with SOVD-compatibl
3838

3939
```bash
4040
# Pull from GitHub Container Registry
41-
docker pull ghcr.io/selfpatch/sovd_web_ui:latest
42-
docker run -p 8080:80 ghcr.io/selfpatch/sovd_web_ui:latest
41+
docker pull ghcr.io/selfpatch/ros2_medkit_web_ui:latest
42+
docker run -p 8080:80 ghcr.io/selfpatch/ros2_medkit_web_ui:latest
4343

4444
# Or build locally
45-
docker build -t sovd_web_ui .
46-
docker run -p 8080:80 sovd_web_ui
45+
docker build -t ros2_medkit_web_ui .
46+
docker run -p 8080:80 ros2_medkit_web_ui
4747
```
4848

4949
Then open http://localhost:8080 in your browser.

SECURITY.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Security vulnerabilities are taken seriously. I appreciate your efforts to respo
1111
Instead, please report them using one of the following methods:
1212

1313
1. **Preferred: GitHub Security Advisories** (recommended)
14-
- Go to the [Security tab](https://github.com/selfpatch/sovd_web_ui/security/advisories/new) of this repository
14+
- Go to the [Security tab](https://github.com/selfpatch/ros2_medkit_web_ui/security/advisories/new) of this repository
1515
- Click "Report a vulnerability"
1616
- Fill out the form with details about the vulnerability
1717

@@ -51,11 +51,11 @@ Please allow reasonable time to investigate and address the vulnerability before
5151
| ------- | ------------------ |
5252
| main | :white_check_mark: |
5353

54-
**Note:** As sovd_web_ui is currently in early development, security updates will be applied to the `main` branch. Once stable releases are available, this section will be updated with specific version support information.
54+
**Note:** As ros2_medkit_web_ui is currently in early development, security updates will be applied to the `main` branch. Once stable releases are available, this section will be updated with specific version support information.
5555

5656
## Security Best Practices
5757

58-
When using sovd_web_ui:
58+
When using ros2_medkit_web_ui:
5959

6060
- Use HTTPS when connecting to SOVD servers over public networks
6161
- Do not expose the web UI to untrusted networks without proper authentication at the SOVD server level
@@ -64,6 +64,6 @@ When using sovd_web_ui:
6464

6565
## Questions?
6666

67-
If you have questions about this security policy or the security of sovd_web_ui, please open an issue in the repository.
67+
If you have questions about this security policy or the security of ros2_medkit_web_ui, please open an issue in the repository.
6868

69-
Thank you for helping keep sovd_web_ui and its users safe!
69+
Thank you for helping keep ros2_medkit_web_ui and its users safe!

0 commit comments

Comments
 (0)