You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update NIST viewer README for product-specific directory structure
Update documentation to reflect the new product-specific directory
structure where each product (rhel8, rhel9, rhel10) has its own
subdirectory with a complete set of viewer pages.
Changes:
- Updated directory tree showing product subdirectories
- Documented file size improvement (2.5MB vs 7.5MB per page)
- Added note about product-specific data embedding
- Updated manual generation instructions
- Clarified that index.html redirects to rhel9 by default
- Removed references to localStorage-based product switching
open ../../build/nist-controls-viewer/rhel9/index.html
110
121
```
111
122
112
123
## Published Version
@@ -119,9 +130,14 @@ The published version updates automatically when changes are pushed to the maste
119
130
120
131
## Data Structure
121
132
122
-
The viewer embeds all control data directly in each HTML file (as `EMBEDDED_DATA` JavaScript constant). This allows the viewer to work when opened directly as local files without CORS issues or requiring a web server.
133
+
The viewer generates product-specific pages in separate subdirectories (rhel8/, rhel9/, rhel10/). Each product's pages embed only that product's data (as `EMBEDDED_DATA` JavaScript constant), significantly reducing file sizes and improving performance.
123
134
124
-
Data is embedded in all pages identically, allowing each page to function independently. Pages communicate via URL parameters (e.g., `control-detail.html?id=ac-2`) and localStorage (for product selection and TODOs).
135
+
Product-specific data structure:
136
+
- Each product subdirectory contains a complete set of viewer pages
137
+
- Each page embeds only that product's control data (~2.5MB vs ~7.5MB for all products)
138
+
- Pages communicate via URL parameters (e.g., `control-detail.html?id=ac-2`)
139
+
- TODOs are stored in localStorage per-control
140
+
- Product switching is done via links in the header (not localStorage)
125
141
126
142
A separate `nist-controls-data.json` file is also generated for reference and debugging purposes.
0 commit comments