|
| 1 | +# Boost Library Usage Analysis |
| 2 | + |
| 3 | +This repository hosts comprehensive analysis and statistics of Boost C++ Library usage across GitHub repositories, organized by Boost version. |
| 4 | + |
| 5 | +## Repository Structure |
| 6 | + |
| 7 | +``` |
| 8 | +. |
| 9 | +├── index.html # Version selector (root landing page) |
| 10 | +├── v1.90/ # Boost 1.90 analysis |
| 11 | +│ ├── index.html # Main dashboard |
| 12 | +│ ├── bsl_analysis.html # BSL-1.0 license analysis |
| 13 | +│ ├── data_to_release_note.html # Release notes data |
| 14 | +│ ├── dashboard_data.json # Dashboard data |
| 15 | +│ └── libraries/ # Individual library detail pages |
| 16 | +│ ├── algorithm.html |
| 17 | +│ ├── asio.html |
| 18 | +│ └── ... |
| 19 | +├── v1.91/ # Boost 1.91 analysis (when available) |
| 20 | +│ └── ... |
| 21 | +└── _config.yml # Jekyll configuration |
| 22 | +``` |
| 23 | + |
| 24 | +## Adding a New Version |
| 25 | + |
| 26 | +When a new Boost version (e.g., 1.91) becomes available: |
| 27 | + |
| 28 | +1. **Create the version directory:** |
| 29 | + ```bash |
| 30 | + mkdir v1.91 |
| 31 | + ``` |
| 32 | + |
| 33 | +2. **Copy the structure from the previous version:** |
| 34 | + ```bash |
| 35 | + cp -r v1.90/* v1.91/ |
| 36 | + ``` |
| 37 | + |
| 38 | +3. **Update the files in v1.91/** with new data: |
| 39 | + - Update `index.html` with new statistics |
| 40 | + - Update `bsl_analysis.html` with new BSL-1.0 data |
| 41 | + - Update `data_to_release_note.html` with new release notes |
| 42 | + - Update `dashboard_data.json` with new dashboard data |
| 43 | + - Update all library detail pages in `libraries/` with new data |
| 44 | + |
| 45 | +4. **Update the root `index.html`:** |
| 46 | + - Add a new version card for v1.91 |
| 47 | + - Mark it as "Latest" (remove "Latest" from previous version) |
| 48 | + - Update the JavaScript `latestVersion` variable if auto-redirect is enabled |
| 49 | + |
| 50 | +5. **Update version references:** |
| 51 | + - Search and replace version numbers in the new version's files |
| 52 | + - Update any hardcoded version references (e.g., "Latest Version: 1.90.0" → "1.91.0") |
| 53 | + |
| 54 | +## File Organization |
| 55 | + |
| 56 | +- **Root `index.html`**: Landing page with version selector |
| 57 | +- **Version directories (`v1.90/`, `v1.91/`, etc.)**: Each contains a complete set of analysis pages for that version |
| 58 | +- **Library detail pages**: Located in `v{version}/libraries/` directory |
| 59 | + |
| 60 | +## Navigation |
| 61 | + |
| 62 | +- Users land on the root `index.html` and select a version |
| 63 | +- Within each version, navigation links are relative (no version prefix needed) |
| 64 | +- Library pages link back to their version's dashboard using `../index.html` |
| 65 | +- All version pages include a "Back to Version Selector" link |
| 66 | + |
| 67 | +## Notes |
| 68 | + |
| 69 | +- All internal links within a version directory use relative paths |
| 70 | +- The root index.html uses absolute paths with version prefixes (e.g., `v1.90/index.html`) |
| 71 | +- When adding new versions, ensure all links are updated correctly |
| 72 | + |
0 commit comments