Add researcher guide and fair usage policy as new data-access docs section - #3609
Conversation
|
Warning Review limit reached
More reviews will be available in 47 minutes and 45 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR introduces comprehensive data access documentation for the AirQo platform: a fair usage policy defining download caps and operational constraints, a researchers guide providing end-to-end methodology and best practices for data access and analysis, and updated sidebar navigation for Docusaurus discoverability. ChangesData Access Documentation & Navigation
Estimated Code Review Effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Adds a new Data Access documentation section to the Docusaurus docs website, publishing two previously-internal guides (researcher guide + fair usage policy) and wiring them into the docs sidebar configuration.
Changes:
- Added
docs/data-access/researchers-guide.md(researcher-facing data access and methodology guide). - Added
docs/data-access/fair-usage-policy.md(batch download limits, API usage, and fairness principles). - Registered a new
dataAccessSidebarautogenerated sidebar insidebars.ts.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/docs-website/sidebars.ts | Adds an autogenerated sidebar entry for the new data-access/ docs section. |
| src/docs-website/docs/data-access/researchers-guide.md | Introduces the researchers’ data access guide with links to API docs and fair usage policy. |
| src/docs-website/docs/data-access/fair-usage-policy.md | Introduces the fair usage policy doc describing batching limits, workflows, and QC guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| --- | ||
|
|
||
| *This document is prepared by AirQo, Makerere University, Kampala, Uganda. For the latest version, contact [support@airqo.net](mailto:support@airqo.net)* |
|
|
||
| --- | ||
|
|
||
| *This document is prepared by AirQo, Makerere University. For the latest information: https://airqo.africa | Contact: [support@airqo.net](mailto:support@airqo.net)* |
|
New azure docs changes available for preview here |
…-access guides Replaced all info@airqo.net references with support@airqo.net in both researchers-guide.md and fair-usage-policy.md so the contact email is consistent throughout — support@airqo.net is the inbox monitored by the technical team.
|
New azure docs changes available for preview here |
|
New azure vertex changes available for preview here |
🚀 Pull Request
📋 Description
What does this PR do?
Introduces a new top-level
data-access/section in the docs-website with two comprehensive guides migrated from internal Word documents:data-access/researchers-guide.md— Full data access guide for academic and scientific researchers: calibration methodology, temporal/spatial aggregation, data quality thresholds, network specs, field deployment guidance, WHO reference levels, FAQ, terms of use, and a quick-reference checklist appendix.data-access/fair-usage-policy.md— Fair usage policy covering the rationale for the 3-month batch download limit, batch download workflows, API rate limiting principles, fair usage principles table, and data quality/completeness guidance.sidebars.ts— NewdataAccessSidebarentry added, autogenerated fromdata-access/.Why is this change needed?
Both documents previously existed only as internal Word files shared on request. Migrating them into the docs-website makes them:
docs.airqo.netexternal link referenced in these guides is replaced with internal links to../api/intro.md.The
data-access/top-level placement (rather than insideapi/oranalytics/) reflects that both guides apply across multiple AirQo products (Analytics Platform, API, and Mobile App).🔗 Related Issues
🔄 Type of Change
🏗️ Affected Services
Microservices changed: N/A — documentation only.
🧪 Testing
Test summary:
Verified Docusaurus build passes with no broken-link errors. Confirmed that cross-links between the two new pages (
./fair-usage-policy.md↔./researchers-guide.md) and from the new pages to the API intro (../api/intro.md) all resolve correctly. The retiringdocs.airqo.netURL has been replaced with the internal API link throughout both files.💥 Breaking Changes
📝 Additional Notes
dataAccessSidebaris autogenerated, so adding further guides underdocs/data-access/in future PRs requires no sidebar config changes.✅ Checklist
Summary by CodeRabbit
Documentation