Add documentation for Nexus#3763
Merged
Merged
Conversation
…organization management guides - Created `analytics-dashboard.md` to detail the features and usage of the Nexus Dashboard for monitoring air quality. - Added `interactive-map.md` to explain the functionalities of the Interactive Map for exploring air quality data across Africa. - Introduced organization management documentation including `managing-members.md`, `member-requests.md`, `organization-settings.md`, and `roles-and-permissions.md` to guide administrators in managing members, roles, and settings. - Established categories for organization management and visualizing data in the documentation structure. - Developed `dataset-visualizer.md` to provide instructions on using the Dataset Visualizer for uploading and analyzing air quality data.
OchiengPaul442
added
documentation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (2)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocs, site metadata, sidebar wiring, and product navigation are updated to replace AirQo Analytics references with AirQo Nexus and to point updated links at nexus.airqo.net across the docs site. ChangesAirQo Nexus Rebrand
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
Suggested labels: Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Git: Failed to clone repository. Please run the 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 |
Contributor
|
New azure docs changes available for preview here |
Contributor
|
New azure docs changes available for preview here |
OchiengPaul442
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a new Nexus documentation section in the Docusaurus docs site and updates existing references/UI from Analytics → Nexus, including docs navigation structure and SEO metadata.
Changes:
- Add a Nexus docs tree (getting started, monitoring air quality, visualizing data, exporting data, org management, help/feedback) with category structure.
- Rebrand docs-site product navigation from “Analytics” to “Nexus” (dropdown + homepage product section) and update Docusaurus sidebar key accordingly.
- Update existing Vertex documentation to point organization-management guidance to Nexus docs.
Reviewed changes
Copilot reviewed 19 out of 29 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/docs-website/src/components/ProductSection/index.tsx | Renames “Analytics” product card to “Nexus” and updates link target. |
| src/docs-website/src/components/ProductDropdown/index.tsx | Renames “Analytics” dropdown entry to “Nexus” and updates docs path. |
| src/docs-website/sidebars.ts | Replaces analytics sidebar with an autogenerated Nexus sidebar. |
| src/docs-website/docusaurus.config.ts | Updates meta description/keywords to reference Nexus instead of Analytics. |
| src/docs-website/docs/vertex/getting-started/for-organizations.md | Updates org-init/team-management references to Nexus + links to Nexus roles docs. |
| src/docs-website/docs/nexus/intro.md | Adds/updates Nexus overview and onboarding “Where to Start” entry points. |
| src/docs-website/docs/nexus/getting-started/category.json | Adds “Getting Started” category for Nexus docs. |
| src/docs-website/docs/nexus/getting-started/creating-an-account.md | New Nexus account creation guide (rebranded from Analytics). |
| src/docs-website/docs/nexus/getting-started/logging-in.md | New Nexus login guide (rebranded from Analytics). |
| src/docs-website/docs/nexus/getting-started/resetting-your-password.md | New Nexus password reset guide (rebranded from Analytics). |
| src/docs-website/docs/nexus/getting-started/deleting-your-account.md | New Nexus account deletion guide (rebranded from Analytics). |
| src/docs-website/docs/nexus/getting-started/navigating-the-platform.md | New Nexus navigation/workflows guide (rebranded from Analytics). |
| src/docs-website/docs/nexus/monitoring-air-quality/category.json | Adds “Monitoring Air Quality” category for Nexus docs. |
| src/docs-website/docs/nexus/monitoring-air-quality/analytics-dashboard.md | Adds Nexus dashboard documentation (renamed heading/label). |
| src/docs-website/docs/nexus/monitoring-air-quality/interactive-map.md | Adds/updates Interactive Map documentation (rebranded to Nexus). |
| src/docs-website/docs/nexus/monitoring-air-quality/air-quality-levels.md | Updates air-quality-level descriptions to Nexus branding. |
| src/docs-website/docs/nexus/managing-locations/category.json | Adds “Managing Your Locations” category for Nexus docs. |
| src/docs-website/docs/nexus/managing-locations/favorite-locations.md | Adds Favorites documentation for Nexus workflows. |
| src/docs-website/docs/nexus/exporting-data/category.json | Adds “Data Export” category for Nexus docs. |
| src/docs-website/docs/nexus/exporting-data/data-export.md | Adds/updates Data Export documentation (rebranded to Nexus). |
| src/docs-website/docs/nexus/visualizing-data/category.json | Adds “Visualizing Data” category for Nexus docs. |
| src/docs-website/docs/nexus/visualizing-data/dataset-visualizer.md | Adds/updates Dataset Visualizer documentation (rebranded to Nexus). |
| src/docs-website/docs/nexus/organization-management/category.json | Adds “Organization Management” category for Nexus docs. |
| src/docs-website/docs/nexus/organization-management/managing-members.md | Adds member invite/roles/removal documentation for org admins. |
| src/docs-website/docs/nexus/organization-management/member-requests.md | Updates member request docs to Nexus branding. |
| src/docs-website/docs/nexus/organization-management/organization-settings.md | Adds organization settings/theme/group details documentation. |
| src/docs-website/docs/nexus/organization-management/roles-and-permissions.md | Updates roles/permissions intro language to Nexus branding. |
| src/docs-website/docs/nexus/help-and-feedback/category.json | Adds “Help & Feedback” category for Nexus docs. |
| src/docs-website/docs/nexus/help-and-feedback/sharing-feedback.md | Updates feedback guide to Nexus branding. |
Comments suppressed due to low confidence (2)
src/docs-website/docs/nexus/intro.md:20
- The Nexus docs intro still points users to an "Analytics Dashboard" in the "Where to Start" table, but the dashboard page itself has been renamed to "AirQo Nexus Dashboard". This is likely to confuse readers during the Analytics → Nexus rebrand.
src/docs-website/docs/nexus/monitoring-air-quality/air-quality-levels.md:33 - This page was updated to refer to the "AirQo Nexus Dashboard", but the "Related Guides" section still links to "Analytics Dashboard". The link text should match the renamed page title to avoid mixed branding.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
New azure docs changes available for preview here |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/docs-website/docs/nexus/getting-started/creating-an-account.md`:
- Around line 18-19: Normalize the Nexus route examples in the getting-started
account guide by removing the extra slash after nexus.airqo.net in the table
entries and any other affected links. Update the markdown examples for the
Individual and Organization paths, and check the related sections referenced in
the comment so all Nexus URLs consistently use the correct single-slash route
format.
In `@src/docs-website/docs/nexus/getting-started/logging-in.md`:
- Around line 14-17: Normalize the Nexus URLs used in the logging-in
documentation so they use the same single-slash path format as the rest of the
site. Update the affected link targets in this section (and the other referenced
occurrence) by editing the markdown in the relevant docs entries so the links
from the login page and home page point to consistent Nexus addresses without
the duplicated slash.
In `@src/docs-website/docs/nexus/getting-started/resetting-your-password.md`:
- Line 14: The Nexus password-reset links still contain a duplicated slash in
the login route, so update the Markdown links in the getting-started reset
password doc to use the correct user/login path. Fix both occurrences referenced
by the AirQo Nexus login link text so the URLs match the app’s actual route and
remain consistent when copied.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 10c1bfc3-3bcc-4ea7-9794-455c14f7bbb0
📒 Files selected for processing (29)
src/docs-website/docs/nexus/exporting-data/_category_.jsonsrc/docs-website/docs/nexus/exporting-data/data-export.mdsrc/docs-website/docs/nexus/getting-started/_category_.jsonsrc/docs-website/docs/nexus/getting-started/creating-an-account.mdsrc/docs-website/docs/nexus/getting-started/deleting-your-account.mdsrc/docs-website/docs/nexus/getting-started/logging-in.mdsrc/docs-website/docs/nexus/getting-started/navigating-the-platform.mdsrc/docs-website/docs/nexus/getting-started/resetting-your-password.mdsrc/docs-website/docs/nexus/help-and-feedback/_category_.jsonsrc/docs-website/docs/nexus/help-and-feedback/sharing-feedback.mdsrc/docs-website/docs/nexus/intro.mdsrc/docs-website/docs/nexus/managing-locations/_category_.jsonsrc/docs-website/docs/nexus/managing-locations/favorite-locations.mdsrc/docs-website/docs/nexus/monitoring-air-quality/_category_.jsonsrc/docs-website/docs/nexus/monitoring-air-quality/air-quality-levels.mdsrc/docs-website/docs/nexus/monitoring-air-quality/analytics-dashboard.mdsrc/docs-website/docs/nexus/monitoring-air-quality/interactive-map.mdsrc/docs-website/docs/nexus/organization-management/_category_.jsonsrc/docs-website/docs/nexus/organization-management/managing-members.mdsrc/docs-website/docs/nexus/organization-management/member-requests.mdsrc/docs-website/docs/nexus/organization-management/organization-settings.mdsrc/docs-website/docs/nexus/organization-management/roles-and-permissions.mdsrc/docs-website/docs/nexus/visualizing-data/_category_.jsonsrc/docs-website/docs/nexus/visualizing-data/dataset-visualizer.mdsrc/docs-website/docs/vertex/getting-started/for-organizations.mdsrc/docs-website/docusaurus.config.tssrc/docs-website/sidebars.tssrc/docs-website/src/components/ProductDropdown/index.tsxsrc/docs-website/src/components/ProductSection/index.tsx
…sword reset documentation
Contributor
|
New azure docs changes available for preview here |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
analytics-dashboard.mdto detail the features and usage of the Nexus Dashboard for monitoring air quality.interactive-map.mdto explain the functionalities of the Interactive Map for exploring air quality data across Africa.managing-members.md,member-requests.md,organization-settings.md, androles-and-permissions.mdto guide administrators in managing members, roles, and settings.dataset-visualizer.mdto provide instructions on using the Dataset Visualizer for uploading and analyzing air quality data.Status of maturity (all need to be checked before merging):
Screenshots (optional)
Summary by CodeRabbit
Documentation
New Features
Chores