seo-crawl-audit 0.7.1 → 0.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -10,6 +10,33 @@ results stay in local JSON, checkpoint, CSV, and self-contained HTML files.
10
10
  [Open the interactive example report](https://melnixdev.github.io/seo-crawl-audit/)
11
11
  or [view its source file](examples/quotes-toscrape-report.html).
12
12
 
13
+ ## Report preview
14
+
15
+ The report is a self-contained HTML file: open it locally, share it as an
16
+ artifact, or publish the same file on GitHub Pages. Charts and filters work
17
+ without a server.
18
+
19
+ ### Overview and local history
20
+
21
+ ![SEO Crawl Audit summary cards and local scan history](https://raw.githubusercontent.com/MelnixDev/seo-crawl-audit/main/docs/images/report-overview.png)
22
+
23
+ The overview keeps scan coverage, issue counts, and locally stored trends in
24
+ one place.
25
+
26
+ ### Interactive issue analytics
27
+
28
+ ![SEO Crawl Audit interactive issue statistics](https://raw.githubusercontent.com/MelnixDev/seo-crawl-audit/main/docs/images/report-analytics.png)
29
+
30
+ Select a severity, rule, lifecycle state, or page template to filter the issue
31
+ table immediately.
32
+
33
+ ### Filtered issue table
34
+
35
+ ![SEO Crawl Audit issue table filtered to errors](https://raw.githubusercontent.com/MelnixDev/seo-crawl-audit/main/docs/images/report-issues.png)
36
+
37
+ Chart selections and report filters narrow the table to the findings that need
38
+ attention, with evidence and remediation kept alongside each issue.
39
+
13
40
  ## Highlights
14
41
 
15
42
  - automatic `robots.txt`, sitemap, sitemap-index, and gzip sitemap support;
@@ -382,6 +409,11 @@ packages/cli seo-crawl-audit — terminal UX and npm executable
382
409
  packages/action @seo-crawl-audit/action — GitHub runner entry point
383
410
  ```
384
411
 
412
+ `@seo-crawl-audit/core` is currently an internal workspace package and is not
413
+ published separately on npm. Install `seo-crawl-audit` for the supported,
414
+ self-contained CLI. The imports below document the repository API used by the
415
+ CLI and Action and are intended for contributors working in this workspace.
416
+
385
417
  ```ts
386
418
  import { audit, planScan, scan } from "@seo-crawl-audit/core";
387
419
  import { createFileCheckpointStore } from "@seo-crawl-audit/core/node";