docs: update screens (#24)

Ne4to · Feb 5, 2024 · 7cf848a · 7cf848a
1 parent 11c2271
commit 7cf848a
Show file tree

Hide file tree

Showing 36 changed files with 74 additions and 19 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -7,7 +7,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <VersionPrefix>0.7.0</VersionPrefix>
+    <VersionPrefix>0.8.0</VersionPrefix>
     <RepositoryUrl>https://github.com/Ne4to/Heartbeat</RepositoryUrl>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # Heartbeat
-[![NuGet Badge](https://buildstats.info/nuget/heartbeat?includePreReleases=true&dWidth=0)](https://www.nuget.org/packages/Heartbeat/)
+[![NuGet Badge](https://buildstats.info/nuget/heartbeat?includePreReleases=false&dWidth=0)](https://www.nuget.org/packages/Heartbeat/)
 
 Diagnostics utility with web UI to analyze .NET application memory dump
 
@@ -66,7 +66,9 @@ Options:
   -?, -h, --help            Show help and usage information
 ```
 
-See [UI screen](https://github.com/Ne4to/Heartbeat/tree/master/assets) for examples.
+### Features
+<!-- do not change to relative path, file included in NuGet readme it works only with absolute path -->
+See [Features](https://github.com/Ne4to/Heartbeat/blob/master/docs/features.md) for more info.
 
 ### Listening endpoint
 

diff --git a/assets/01-dashboard.jpeg b/assets/01-dashboard.jpeg
diff --git a/assets/02-heap-dump.jpeg b/assets/02-heap-dump.jpeg
diff --git a/assets/03-segments.jpeg b/assets/03-segments.jpeg
diff --git a/assets/04-roots.jpeg b/assets/04-roots.jpeg
diff --git a/assets/05-modules.jpeg b/assets/05-modules.jpeg
diff --git a/assets/06-strings.jpeg b/assets/06-strings.jpeg
diff --git a/assets/07-string-duplicates.jpeg b/assets/07-string-duplicates.jpeg
diff --git a/assets/08-single-objest.jpeg b/assets/08-single-objest.jpeg
diff --git a/assets/09-object-list.jpeg b/assets/09-object-list.jpeg
diff --git a/assets/README.md b/assets/README.md
diff --git a/docs/assets/01-dashboard.jpeg b/docs/assets/01-dashboard.jpeg
diff --git a/docs/assets/02-heap-dump.jpeg b/docs/assets/02-heap-dump.jpeg
diff --git a/docs/assets/02.1-object-fields.jpeg b/docs/assets/02.1-object-fields.jpeg
diff --git a/docs/assets/02.2-object-root.jpeg b/docs/assets/02.2-object-root.jpeg
diff --git a/docs/assets/02.3-object-array-items.jpeg b/docs/assets/02.3-object-array-items.jpeg
diff --git a/docs/assets/02.4-object-dictionary-items.jpeg b/docs/assets/02.4-object-dictionary-items.jpeg
diff --git a/docs/assets/02.5-object-as-jwt.jpeg b/docs/assets/02.5-object-as-jwt.jpeg
diff --git a/docs/assets/03-segments.jpeg b/docs/assets/03-segments.jpeg
diff --git a/docs/assets/04-roots.jpeg b/docs/assets/04-roots.jpeg
diff --git a/docs/assets/05-modules.jpeg b/docs/assets/05-modules.jpeg
diff --git a/docs/assets/06-sparse-arrays.jpeg b/docs/assets/06-sparse-arrays.jpeg
diff --git a/docs/assets/07-arrays.jpeg b/docs/assets/07-arrays.jpeg
diff --git a/docs/assets/08-http-requests.jpeg b/docs/assets/08-http-requests.jpeg
diff --git a/docs/assets/09-strings.jpeg b/docs/assets/09-strings.jpeg
diff --git a/docs/assets/10-string-duplicates.jpeg b/docs/assets/10-string-duplicates.jpeg
diff --git a/docs/features.md b/docs/features.md
@@ -0,0 +1,61 @@
+- [Basic dump information](#basic-dump-information)
+- [Heap Dump](#heap-dump)
+  - [Object fields](#object-fields)
+  - [Object GC root path](#object-gc-root-path)
+  - [Array items](#array-items)
+  - [Dictionary items](#dictionary-items)
+  - [Decode JSON Web Token (JWT)](#decode-json-web-token-jwt)
+- [Heap segments](#heap-segments)
+- [Heap roots](#heap-roots)
+- [Modules](#modules)
+- [Sparse arrays summary](#sparse-arrays-summary)
+- [Arrays](#arrays)
+- [HTTP requests](#http-requests)
+- [Strings](#strings)
+- [String duplicates](#string-duplicates)
+
+### Basic dump information
+<a href="./assets/01-dashboard.jpeg"><img src="./assets/01-dashboard.jpeg" alt="Dashboard" width="60%"/><a>
+
+### Heap Dump
+<a href="./assets/02-heap-dump.jpeg"><img src="./assets/02-heap-dump.jpeg" alt="Heap dump" width="60%"/><a>
+
+#### Object fields
+<a href="./assets/02.1-object-fields.jpeg"><img src="./assets/02.1-object-fields.jpeg" alt="Object fields" width="60%"/><a>
+
+#### Object GC root path
+<a href="./assets/02.2-object-root.jpeg"><img src="./assets/02.2-object-root.jpeg" alt="Object GC root path" width="60%"/><a>
+
+#### Array items
+<a href="./assets/02.3-object-array-items.jpeg"><img src="./assets/02.3-object-array-items.jpeg" alt="Array items" width="60%"/><a>
+
+#### Dictionary items
+<a href="./assets/02.4-object-dictionary-items.jpeg"><img src="./assets/02.4-object-dictionary-items.jpeg" alt="Dictionary items" width="60%"/><a>
+
+#### Decode JSON Web Token (JWT)
+<a href="./assets/02.5-object-as-jwt.jpeg"><img src="./assets/02.5-object-as-jwt.jpeg" alt="JWT" width="60%"/><a>
+
+### Heap segments
+<a href="./assets/03-segments.jpeg"><img src="./assets/03-segments.jpeg" alt="Segments" width="60%"/><a>
+
+### Heap roots
+<a href="./assets/04-roots.jpeg"><img src="./assets/04-roots.jpeg" alt="Roots" width="60%"/><a>
+
+### Modules
+<a href="./assets/05-modules.jpeg"><img src="./assets/05-modules.jpeg" alt="Modules" width="60%"/><a>
+
+### Sparse arrays summary
+<a href="./assets/06-sparse-arrays.jpeg"><img src="./assets/06-sparse-arrays.jpeg" alt="Sparse arrays summary" width="60%"/><a>
+
+### Arrays
+<a href="./assets/07-arrays.jpeg"><img src="./assets/07-arrays.jpeg" alt="Arrays" width="60%"/><a>
+
+### HTTP requests
+<a href="./assets/08-http-requests.jpeg"><img src="./assets/08-http-requests.jpeg" alt="HTTP requests" width="60%"/><a>
+
+### Strings
+<a href="./assets/09-strings.jpeg"><img src="./assets/09-strings.jpeg" alt="Strings" width="60%"/><a>
+
+### String duplicates
+<a href="./assets/10-string-duplicates.jpeg"><img src="./assets/10-string-duplicates.jpeg" alt="String duplicates" width="60%"/><a>
+
diff --git a/src/Heartbeat/ClientApp/src/pages/arraysGrid/index.ts b/src/Heartbeat/ClientApp/src/pages/arraysGrid/index.ts
@@ -1,4 +1,4 @@
-import Icon from '@mui/icons-material/ViewModule';
+import Icon from '@mui/icons-material/ViewArray';
 import { ArraysGrid } from './ArraysGrid';
 
 export default {

diff --git a/src/Heartbeat/ClientApp/src/pages/clrObject/ClrObject.tsx b/src/Heartbeat/ClientApp/src/pages/clrObject/ClrObject.tsx
@@ -21,6 +21,7 @@ import {ClrObjectRoot} from "../../components/ClrObjectRoot";
 import {ProgressContainer} from "../../components/ProgressContainer";
 import Box from "@mui/material/Box";
 
+// TODO add refs to current object
 // TODO add Dictionary, Queue, Stack and other collections view to a new tab
 // TODO add ConcurrentDictionary view to a new tab (dcd, dumpconcurrentdictionary <address>    Displays concurrent dictionary content.)
 // TODO add ConcurrentQueue view to a new tab (dcq, dumpconcurrentqueue <address>         Displays concurrent queue content.)

diff --git a/src/Heartbeat/ClientApp/src/pages/httpRequests/index.ts b/src/Heartbeat/ClientApp/src/pages/httpRequests/index.ts
@@ -1,4 +1,4 @@
-import Icon from '@mui/icons-material/ViewModule';
+import Icon from '@mui/icons-material/Http';
 import { HttpRequests } from './HttpRequests';
 
 export default {

diff --git a/src/Heartbeat/ClientApp/src/pages/roots/index.ts b/src/Heartbeat/ClientApp/src/pages/roots/index.ts
@@ -1,4 +1,4 @@
-import Icon from '@mui/icons-material/ViewModule';
+import Icon from '@mui/icons-material/AccountTree';
 import { RootsGrid } from './RootsGrid';
 
 export default {

diff --git a/src/Heartbeat/ClientApp/src/pages/segments/index.ts b/src/Heartbeat/ClientApp/src/pages/segments/index.ts
@@ -1,4 +1,4 @@
-import Icon from '@mui/icons-material/Comment';
+import Icon from '@mui/icons-material/LowPriority';
 import { SegmentsGrid } from './SegmentsGrid';
 
 export default {

diff --git a/src/Heartbeat/ClientApp/src/pages/sparseArraysStat/index.ts b/src/Heartbeat/ClientApp/src/pages/sparseArraysStat/index.ts
@@ -1,4 +1,4 @@
-import Icon from '@mui/icons-material/ViewModule';
+import Icon from '@mui/icons-material/DataArray';
 import { SparseArraysStat } from './SparseArraysStat';
 
 export default {

diff --git a/src/Heartbeat/ClientApp/src/pages/stringDuplicates/index.ts b/src/Heartbeat/ClientApp/src/pages/stringDuplicates/index.ts
@@ -1,4 +1,4 @@
-import Icon from '@mui/icons-material/ViewModule';
+import Icon from '@mui/icons-material/Layers';
 import { StringDuplicates } from './StringDuplicates';
 
 export default {

diff --git a/src/Heartbeat/ClientApp/src/pages/stringsGrid/index.ts b/src/Heartbeat/ClientApp/src/pages/stringsGrid/index.ts
@@ -1,4 +1,4 @@
-import Icon from '@mui/icons-material/ViewModule';
+import Icon from '@mui/icons-material/Gesture';
 import { StringsGrid } from './StringsGrid';
 
 export default {