Skip to content

[Documentation] Updated docs for v1 #1914

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

Merged
alexjustesen merged 6 commits into from
Dec 13, 2024
Merged

[Documentation] Updated docs for v1 #1914

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8bdff36
removed postman collection
alexjustesen Dec 12, 2024
99995d4
updated readme to reference the docs
alexjustesen Dec 12, 2024
fe9c3c7
updated dashboard screenshot
alexjustesen Dec 12, 2024
9023d93
Merge branch 'main' into updated-docs-for-v1
alexjustesen Dec 13, 2024
3a48a17
Refactor README to enhance feature descriptions and improve clarity
alexjustesen Dec 13, 2024
6e2c4d7
Update README to replace star history chart with dashboard screenshot
alexjustesen Dec 13, 2024
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
Prev Previous commit
Next Next commit
updated dashboard screenshot
  • Loading branch information
@alexjustesen
alexjustesen committed Dec 12, 2024
commit fe9c3c79871bbc7f052d24e20ca042e8693bc367
Binary file added .github/screenshots/dashboard.jpeg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/screenshots/dashboard_screenshot.jpg
View file
Open in desktop
Binary file not shown.
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ As far as I can tell https://github.com/henrywhitaker3/Speedtest-Tracker was aba

## Getting Started

![Dashboard](.github/screenshots/dashboard.jpeg)

Speedtest Tracker is containerized so you can run it anywhere you run your containers. The image is built by LinuxServer.io, build information can be found [here](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker).

- [Installation](https://docs.speedtest-tracker.dev/getting-started/installation) will help you get up and running if you're deploying the Docker image or to a NAS platform like Synology and Unraid.
Expand All @@ -24,8 +26,3 @@ Speedtest Tracker is containerized so you can run it anywhere you run your conta

- [Frequently Asked Questions](https://docs.speedtest-tracker.dev/help/faqs) is a collection of common questions.
- [Error Messages](https://docs.speedtest-tracker.dev/help/error-messages) are thrown when the application experiences a problem. These can help you resolve issues you might experience.

## Screenshots

![Dashboard](.github/screenshots/dashboard_screenshot.jpg)
**Dashboard**