AppSideNav - Web docs (HDS-3807)
#2410
Merged
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
1 task
KristinLBradley
force-pushed
the
hds-3807-app-sidenav-docs
branch
from
f2dd98b
to
7964b7d
Compare
KristinLBradley
changed the base branch from
main
to
hds-3800-app-sidenav-component
KristinLBradley
force-pushed
the
hds-3807-app-sidenav-docs
branch
from
9ffac4b
to
f5a98ed
Compare
2 tasks
KristinLBradley
force-pushed
the
hds-3800-app-sidenav-component
branch
3 times, most recently
from
024aca1
to
4db2dcf
Compare
KristinLBradley
force-pushed
the
hds-3807-app-sidenav-docs
branch
from
f5a98ed
to
90c317b
Compare
KristinLBradley
force-pushed
the
hds-3807-app-sidenav-docs
branch
from
9f512e0
to
22d61f6
Compare
KristinLBradley
changed the title
AppSideNav - web docs (HDS-3807)AppSideNav - web docs sub-branch (HDS-3807)
shleewhite
reviewed
Sep 27, 2024
| @@ -0,0 +1,5 @@ | |||
| ## 4.10.0 | |||
There was a problem hiding this comment.
Note: this will need to be updated to the correct version number
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
| - `isDesktop` | ||
| - `isMinimized` | ||
|
|
||
|  |
There was a problem hiding this comment.
Nit: I think it would be better to try and get more of this information out of the image and into the page. Maybe a table with the images and captions describing each state?
|
|
||
| #### `aria` attributes | ||
|
|
||
| The App Side Nav component already provides some of the required `aria` attributes. But other attributes are needed when declaring its content. Please refer to the [Accessibility](/components/app-side-nav?tab=accessibility) section for more details. |
There was a problem hiding this comment.
Nit: There isn't really anything in the a11y tab describing what attributes are needed when declaring the content. Can you specify here?
website/docs/components/app-side-nav/partials/specifications/anatomy.md
Outdated
Show resolved
Hide resolved
KristinLBradley
changed the title
AppSideNav - web docs sub-branch (HDS-3807)AppSideNav - Web docs (HDS-3807)
|
Thanks for all of your detailed suggestions @shleewhite ! I think I caught everything pertaining to the guidelines and the anatomy. |
KristinLBradley
force-pushed
the
hds-3800-app-sidenav-component
branch
from
76b8cf0
to
a6a8164
Compare
|
I'm going to merge this docs branch into the component branch and then continue to make updates there and in child branches as needed from Brian's advice. |
KristinLBradley
force-pushed
the
hds-3807-app-sidenav-docs
branch
from
c4d5806
to
af6c5dc
Compare
KristinLBradley
merged commit d1e1b8e
into
hds-3800-app-sidenav-component
14 checks passed
KristinLBradley
added a commit
that referenced
this pull request
Oct 25, 2024
Co-authored-by: Jory Tindall <[email protected]>
KristinLBradley
added a commit
that referenced
this pull request
Oct 29, 2024
Co-authored-by: Jory Tindall <[email protected]>
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.
📌 Summary
If merged, this PR will add documentation for the
AppSideNavto HDS.Preview: https://hds-website-git-hds-3807-app-sidenav-docs-hashicorp.vercel.app/components/app-side-nav
Related branches:
AddSideComponent:AppSideNav- Component branch (HDS-3800) #2384SideNavDeprecation:SideNav- Deprecate component (HDS-3848) #2425🔗 External links
👀 Component checklist
[ ] Percy was checked for any visual regression[ ] A changelog entry was added via Changesets if needed (see templates here)💬 Please consider using conventional comments when reviewing this PR.