docs: Updated the docs to persona driven#13
Merged
r0ssing merged 2 commits intoOpenDataEnsemble:mainfrom Mar 22, 2026
Merged
Conversation
Bahati308
requested review from
najuna-brian and
r0ssing
and removed request for
r0ssing
Contributor
|
Looks great! 👓 🦒 |
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
2 participants
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.
docs: Updated the docs to persona driven
Type of Change
This change implements a persona-driven navigation structure for the ODE documentation site, organizing content around user roles to improve discoverability and user experience.
Key Changes Made
New Documentation Files Created:
docs/welcome.md - Introductory landing page for all users
docs/for-data-collectors.md - Content tailored for data collection workflows
docs/for-implementers.md - Guidance for implementation and deployment
docs/for-developers.md - Technical development resources
Sidebar Configuration Updates:
Modified [sidebars.ts] to replace the previous flat structure with persona-based categories:
"Welcome" (top-level intro)
"For Data Collectors" (data-focused docs)
"For Implementers" (implementation docs)
"For Developers" (development docs)
Versioning Resolution:
Restored original [versioned_sidebars] to prevent conflicts with main documentation
Ensured main docs folder takes precedence over versioned content
Impact and Benefits
Improves content organization by user role, making it easier for different audiences to find relevant information
Maintains backward compatibility with existing doc IDs and structure
Resolves previous sidebar rendering issues by disabling conflicting versioned sidebars
Component(s) Affected
Related PRs
Thank you for contributing to Open Data Ensemble (ODE)!