Skip to content

docs: fix stale references and fill in missing documentation#1120

Open
vringar wants to merge 2 commits intomasterfrom
docs/fix-stale-references
Open

docs: fix stale references and fill in missing documentation#1120
vringar wants to merge 2 commits intomasterfrom
docs/fix-stale-references

Conversation

@vringar
Copy link
Contributor

@vringar vringar commented Feb 15, 2026

Fix incorrect file paths, outdated references, and fill in missing documentation sections.

First commit fixes wrong paths (DataAggregator → storage/, BrowserManager.py → browser_manager.py, etc.) and a couple of typos.

Second commit fills in the TODO instrument descriptions, adds Platform Configuration Options, and updates stale version references.

@vringar vringar force-pushed the docs/fix-stale-references branch 2 times, most recently from 48dc880 to 0657877 Compare February 17, 2026 19:39
@codecov
Copy link

codecov bot commented Feb 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 37.32%. Comparing base (c438c9f) to head (0657877).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1120      +/-   ##
==========================================
+ Coverage   35.19%   37.32%   +2.12%     
==========================================
  Files          35       35              
  Lines        3475     3475              
==========================================
+ Hits         1223     1297      +74     
+ Misses       2252     2178      -74     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

- Fix headless parameter: 'headless' browser param → display_mode = "headless"
- Fix DataAggregator paths → openwpm/storage/ (README and Platform-Architecture)
- Fix BrowserManager.py → browser_manager.py
- Fix SocketInterface.py → socket_interface.py
- Fix typo: you're → your
- Specify Ubuntu versions: 24.04 for CI, 22.04 for Docker
- Fill in TODO instrument docs: navigation_instrument, callstack_instrument, dns_instrument
- Mark callstack_instrument as broken (matches config.py validation)
- Update Selenium 3 reference and fix docs URL
- Add Platform Configuration Options section to Configuration.md
- Fix 'enviroment' typo in CONTRIBUTING.md
@vringar vringar force-pushed the docs/fix-stale-references branch from dbaf289 to 0b94240 Compare February 19, 2026 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments