Docs Site: Improve Architecture Page Fallback Navigation#116
Closed
kavitha-047 wants to merge 3 commits intoAndrewRedican:mainfrom
Closed
Docs Site: Improve Architecture Page Fallback Navigation#116kavitha-047 wants to merge 3 commits intoAndrewRedican:mainfrom
kavitha-047 wants to merge 3 commits intoAndrewRedican:mainfrom
Conversation
Improved the fallback state for the root architecture page when documentation content is not yet available. This change adds a clearer message and a navigation link back to the main documentation so users are not left at a dead end.
|
@kavitha-047 is attempting to deploy a commit to the hyperfrontend Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
|
✅ All contributors have signed the CLA. Thank you! |
Author
|
I have read the CLA Document and I hereby sign the CLA |
|
View your CI Pipeline Execution ↗ for commit f39bbea
☁️ Nx Cloud last updated this comment at |
AndrewRedican
changed the title
AndrewRedican
changed the title
Owner
|
Hi @kavitha-047 after some careful consideration, I won't be accepting this change. It's no longer needed, as all architecture details have been provided. When a link leads to a page that does not exist, there is a 404 page that helps a user get back on track. Alternatively, based on your experience instead, you could share with me how was your self-onboarding experience like, any particular paint points, and we can discuss how to improve and plan what changes can be done to the codebase. |
Author
|
Hi @AndrewRedican, thanks for the clarification!
My onboarding experience was interesting, but I did face a few challenges:
-
It took me some time to understand the overall architecture and how
different parts of the project connect.
-
I wasn’t always sure where to start or which files were the right entry
points.
-
Some setup or flow explanations could be a bit clearer for new
contributors.
I think adding a simple “getting started flow” or visual overview of the
architecture could really help new contributors ramp up faster.
Happy to explore this further and contribute improvements if needed!
…On Tue, Apr 21, 2026 at 2:24 AM Andrew Redican ***@***.***> wrote:
*AndrewRedican* left a comment (AndrewRedican/hyperfrontend#116)
<#116?email_source=notifications&email_token=BOOJO3WBKL4MNOI5W6T33BL4W2E7LA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIMRYGQZDCNJYHE2KM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJNLQOJPWG33NNVSW45C7N5YGK3S7MNWGSY3L#issuecomment-4284215894>
Hi @kavitha-047 <https://github.com/kavitha-047> after some careful
consideration, I won't be accepting this change. It's no longer needed, as
all architecture details have been provided. When a link leads to a page
that does not exist, there is a 404 page that helps a user get back on
track.
Alternatively, based on your experience instead, you share with me how was
your self onboarding experience like, any particular paint points, and we
can discuss how to improve and plan what changes can be done to the
codebase.
—
Reply to this email directly, view it on GitHub
<#116?email_source=notifications&email_token=BOOJO3WBKL4MNOI5W6T33BL4W2E7LA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIMRYGQZDCNJYHE2KM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJNLQOJPWG33NNVSW45C7N5YGK3S7MNWGSY3L#issuecomment-4284215894>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BOOJO3SEEKKD3NB7YMMRROL4W2E7LAVCNFSM6AAAAACXQZNVLKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DEOBUGIYTKOBZGQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
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.
Improved the fallback state for the root architecture page when documentation content is not yet available.
This change adds a clearer message and a navigation link back to the main documentation so users are not left at a dead end.