docs: implement persona-based documentation paths (fixes #250) #260
Conversation
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
Implements issue aboutcode-org#250 by creating user-centric documentation paths organized around user goals rather than tools. Changes: - Add three persona landing pages: * Legal/Compliance professionals * Security/SCA professionals * Developers/Integrators - Update homepage with 'Choose Your Path' section - Fix purldb-project label reference Each persona page uses appropriate language and workflows for its target audience, with cross-links between personas where relevant. All existing documentation remains unchanged - this is an additive refactor creating new entry points. Verification: - Documentation builds with zero warnings - All link checks pass - All style checks pass Closes aboutcode-org#250 Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
gyanranjanpanda
force-pushed
the
docs/persona-based-documentation
branch
from
a27ccb5 to
05c8415
Compare
Shortened all three persona landing pages to be more concise: - Legal/Compliance: 117 → 40 lines - Security/SCA: 150 → 45 lines - Developer/Integrator: 226 → 75 lines Changes focus persona pages on quick navigation paths rather than full tutorials. Removed redundant tool descriptions and verbose explanations while keeping essential code examples and links. Total reduction: ~540 → ~160 lines (~70% shorter) Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
Member
|
I am not sure we are ready to do this. Asking @pombredanne or @AyanSinhaMahapatra to help with the review. @gyanranjanpanda please be patient while we take a deeper look at this, thanks. |
Author
|
Thank you for taking a look. I appreciate the deeper review happy to wait and address any feedback from you, @pombredanne, or @AyanSinhaMahapatra. |
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.
Overview
Implements #250 by creating user-centric documentation paths organized around user goals rather than tools.
Changes
New Persona Landing Pages
Created three persona-specific entry points in
docs/source/personas/:Legal/Compliance Professionals (legal-compliance.rst)
Security/SCA Professionals (security-researcher.rst)
Developers/Integrators (developer-integrator.rst)
Updated Homepage
Bug Fix
purldb-project.rstlabel referenceDesign Decisions
Verification
Acceptance Criteria (from #250)
Files Changed
Testing
To view locally:
cd docs make html open build/html/index.htmlNavigate through the "Choose Your Path" section to explore each persona.