Repository navigation
Adding New "End User" Documentation to RHDH Local to help with onboarding etc. - #127
Merged
Merged
Conversation
…dded Lightspeed documentation. Improved the structure. Improved the key benefits page
…ogether, and other tips are moved to the getting started guide.
…getting started section.
…es like the profile page and the starred items system.
Contributor
Author
|
Contributor
|
You are nearing your monthly Qodo Merge usage quota. For more information, please visit here. PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
rhdh-qodo-merge
Bot
added
the
documentation
Contributor
|
You are nearing your monthly Qodo Merge usage quota. For more information, please visit here. PR TypeDocumentation Description
|
| Relevant files | |||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Miscellaneous | 6 files
| ||||||||||||||||||||||||||||||||||||||||||||||||||
| Documentation | 25 files
| ||||||||||||||||||||||||||||||||||||||||||||||||||
| Configuration changes | 1 files
| ||||||||||||||||||||||||||||||||||||||||||||||||||
| Additional files |
Contributor
|
You are nearing your monthly Qodo Merge usage quota. For more information, please visit here. PR Code Suggestions ✨Explore these optional code suggestions:
|
||||||||||||
rm3l
approved these changes
Nov 20, 2025
rm3l
left a comment
rm3l
left a comment
Member
There was a problem hiding this comment.
LGTM. Thanks for these comprehensive and helpful docs 😍
Minor comment about .DS_STORE files.
![rhdh-qodo-merge[bot]](https://avatars.githubusercontent.com/in/1961108?s=60&v=4){kind=small}
rm3l
reviewed
Nov 20, 2025
Member
There was a problem hiding this comment.
Actually, there are some broken links to fix.
I think the main README.md should be updated as well with the right paths: https://github.com/benwilcock/rhdh-local/blob/main/README.md?plain=1#L60-L65
1 of 3 tasks
4 tasks done
4 tasks
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.
Description
This PR adds a new getting started guide intended to help brand new Developer Hub users get started quickly. The guide covers essential first-day tasks:
Core Platform Features
📦 Software Catalog
📋 Software Templates
📚 TechDocs
🧩 API Browser
🔍 Global Search
🧭 Navigation
🔌 Extensions (Plugins)
⚡ Developer Lightspeed
User Experience Features
🌅 Your First Day
🏠 Homepage & Dashboard
⭐ Starred Items
👤 Profile & Settings
Platform Information
🎯 Platform Overview
💡 Best Practices & Tips
📖 References & Resources
The content is written for complete beginners, uses engaging language with emojis and callouts consistent with other getting started guides, and includes practical tips and "Next Steps" sections linking to related documentation.
This addresses a gap identified in the documentation review where new users lacked guidance on basic first-day tasks like logging in, understanding the homepage, and personalizing their experience.
Which issue(s) does this PR fix or relate to
PR acceptance criteria
How to test changes / Special notes to the reviewer
Testing the Documentation
Preview the new page:
Verify content accuracy:
Check consistency:
Test navigation:
navigation.md,software-catalog.md, etc.) are correct/catalog,/create) are properly formattedSpecial Notes