Skip to content

Commit

Permalink
#437 - Added documentation for specify and no-ring 0 specify (#438)
Browse files Browse the repository at this point in the history
* Added specify - No-ring is left

* Added the upload json, as well as created the no ring 0 version

* Applied necessary changes

* minor changes to description

* Updated temps and voltage and making a system dossier - updated main guides desc

* Made headers H2

* Minor changes done according to latest comment

Done and sweeped!

* Remove ! from Important for consitency

---------

Co-authored-by: PipeItToDevNull <[email protected]>
  • Loading branch information
Mr-KayZ and PipeItToDevNull authored Jan 26, 2025
1 parent cb9dd4d commit 5cc31b7
Show file tree
Hide file tree
Showing 7 changed files with 80 additions and 21 deletions.
6 changes: 4 additions & 2 deletions src/_includes/embeds/specify.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Specify is a small tool made by us that gets a bunch of info about your hardware, software, and OS, and allows convenient ways to save and share it. You can download it [here](https://github.com/Spec-ify/specify/releases/latest/download/Specify.exe).
Specify is a custom made, [open-source](https://github.com/Spec-ify/specify) windows app that gathers system information like Operating System, Hardware specifications, and Software information/errors to help us troubleshoot your computer.

Run Specify.exe and follow the prompts, once it is done, it will automatically open a link and copy it to your clipboard. Click "Close Program" at the end to exit. This link will only live for 24 hours.
More information about specify can be found in the following articles:
- [Specify](/factoids/specify)
- [Specify (No-Ring 0)](/factoids/specify-nr)
Binary file added src/assets/specify/specify-debug.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/specify/specify-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions src/content/docs/factoids/specify-nr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Using Specify (No-Ring 0 version)
description: Specify is an open-source windows applications that gathers various data to help us troubleshoot your computer.
sidebar:
hidden: false
parent: Factoids
has_children: false
pagefind: true
last_modified_date: 2024-11-05
---
This is the **No-Ring 0** version, where LibreHardwareMonitor/temperature has been excluded from the report. To get temperature readings, please refer to our [HWinfo guide](/guides/hwinfo).

> [!IMPORTANT] Important
>
> No sensitive information is included in the report, we will not ask you to share private information. You can view an example specify report [here](https://spec-ify.com/profile/demo-noring0).
>
> More information can be found on our [README on GitHub](https://github.com/Spec-ify/specify/blob/main/README.md).
## How to use Specify

1. **Download** the Specify tool from [here](https://github.com/Spec-ify/specify/releases/latest/download/Specify_noring0.exe).
2. **Run** the Specify.exe program.
- If a User Account Control (UAC) window pops up, press yes. If a Windows Smartscreen window pops up, select "More Info" and then "Run Anyway".
3. **(Optional)** - Select Settings and enable the `Remove Username` option if you wish to redact your user name from the report.
4. Click on **Start**, wait for the program to complete scanning the system.
5. Once it is done, it will **automatically open a link and copy it to your clipboard**. Click "Close Program" at the end to exit.
6. Paste this link in the channel you are getting support from.

> [!TIP] For machines without internet access
>
> For machines without internet access, click the settings button and enable the 'Don't Upload' option. Specify will save a file titled "specify_specs.json". Please upload the file instead.
> [!INFORMATION] Data Retention Policies
>
> In compliance with [the GDPR (General Data Protection Regulation)](https://gdpr-info.eu/), the report will **be automatically deleted after 24 hours**. For more information about our data retention policies, please refer to our [README on GitHub](https://github.com/Spec-ify/specify/blob/main/README.md).
34 changes: 34 additions & 0 deletions src/content/docs/factoids/specify.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Using Specify
description: Specify is an open-source windows applications that gathers various data to help us troubleshoot your computer.
sidebar:
hidden: false
parent: Factoids
has_children: false
pagefind: true
last_modified_date: 2024-11-05
---

> [!IMPORTANT] Important
>
> No sensitive information is included in the report, we will not ask you to share private information. You can vew an example specify report [here](https://spec-ify.com/profile/demo1).
>
> More information can be found on our [README on GitHub](https://github.com/Spec-ify/specify/blob/main/README.md)
## How to use Specify

1. **Download** the Specify tool from [here](https://github.com/Spec-ify/specify/releases/latest/download/Specify_noring0.exe).
2. **Run** the Specify.exe program.
- If a User Account Control (UAC) window pops up, press yes. If a Windows Smartscreen window pops up, select "More Info" and then "Run Anyway".
3. **(Optional)** - Select Settings and enable the `Remove Username` option if you wish to redact your user name from the report.
4. Click on **Start**, wait for the program to complete scanning the system.
5. Once it is done, it will **automatically open a link and copy it to your clipboard**. Click "Close Program" at the end to exit.
6. Paste this link in the channel you are getting support from.

> [!TIP] For machines without internet access
>
> For machines without internet access, click the settings button and enable the 'Don't Upload' option. Specify will save a file titled "specify_specs.json". Please upload the file instead.
> [!INFORMATION] Data Retention Policies
>
> In compliance with [the GDPR (General Data Protection Regulation)](https://gdpr-info.eu/), the report will **be automatically deleted after 24 hours**. For more information about our data retention policies, please refer to our [README on GitHub](https://github.com/Spec-ify/specify/blob/main/README.md).
9 changes: 2 additions & 7 deletions src/content/docs/guides/making-a-system-dossier.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,6 @@ last_modified_date: 2024-06-28
redirect_from: /books/how-to-and-guides/page/making-a-system-dossier
---






## What is a system dossier?
A system dossier is a great way to provide needed information about your computer (hardware, software, and OS). While you could list it all by hand, some problems can require a lot of information, and it would be time-consuming to obtain it all manually. The more info you can provide about your computer the easier it is for someone to diagnose your issue, and the more accurate their advice will be.

Expand All @@ -25,10 +20,10 @@ import UseSpecify from '../../../_includes/embeds/specify.md';

<UseSpecify />

Alternatively, you can use [Speccy](https://www.ccleaner.com/speccy/download/standard) to get similar information.
Alternatively, you can use [Get-Specs](/factoids/get-specs) to get similar information.

### msinfo32
msinfo32 is built into Windows. It will provide some of the same information Speccy does. This is more focused on hardware and OS than installed software.
msinfo32 is built into Windows. It will provide some of the same information Specify does. This is more focused on hardware and OS than installed software.

It is best if you run this tool with elevated privileges, but it won't force you to.

Expand Down
17 changes: 5 additions & 12 deletions src/content/docs/recommendations/temps-voltages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ last_modified_date: 2024-06-28
redirect_from: /books/software-we-recommend/page/reading-machine-temperatures-voltages
---



Watching your temperatures is an important part of managing any machine, especially a gaming rig. There are several tools that can work for this, some may not work on all CPUs (Ryzen most notably).
Watching your temperatures is an important part of managing any machine, especially a gaming rig. There are several tools that can work for this, most should work if you have a relatively up-to-date system.

When reporting your temperatures to people, please use Celsius. It doesn't matter what country you are in, everyone uses Celsius for computers.

Expand All @@ -21,14 +19,9 @@ import UseSpecify from '../../../_includes/embeds/specify.md';

<UseSpecify />

Alternatively, you can use [Speccy](https://www.ccleaner.com/speccy/download/standard) to get similar information.

## Ryzen Master
The go-to for ensuring you get proper temperature readings for your Ryzen CPU. If other tools show the same temperature you can assume they are accurate.

[Download](https://download.amd.com/Desktop/AMD-Ryzen-Master.exe)
Alternatively, you can use [Get-Specs](/factoids/get-specs) to get similar information.

## HWiNFO
Like Specs, this has a ton of info, but it is isolated to hardware. We utilize this for extended logging of voltages, temps, etc. during stress tests.
### HWiNFO
Like Specify it reports lots of important useful information, but it is isolated to hardware. We utilize this for extended logging of voltages, temps, etc. during stress tests.

[Download](https://www.hwinfo.com/download/)
Please refer to our [HWinfo guide](/guides/hwinfo) if you wish to see how your PC performs during a stress test or during a game (Game Logging).

0 comments on commit 5cc31b7

Please sign in to comment.