Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AdvancedTable: Website documentation #2628

Merged
merged 24 commits into from
Jan 23, 2025
Merged

Conversation

shleewhite
Copy link
Contributor

@shleewhite shleewhite commented Dec 27, 2024

📌 Summary

If merged, this PR would add documentation for the Advanced Table component to the docs site.

PREVIEW PAGE

🛠️ Detailed description

I currently have the Advanced Table as a subsection of the Table. This can change depending on @hashicorp/hds-design 's final decision.

Screenshot 2024-12-26 at 4 54 58 PM

I also took the applicable examples from the Table docs and adapted them to Advanced Table.

📸 Screenshots

Screenshot 2024-12-26 at 4 56 32 PM

🔗 External links

Jira ticket: HDS-4231
Figma file: [if it applies]


💬 Please consider using conventional comments when reviewing this PR.

Copy link

vercel bot commented Dec 27, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Jan 23, 2025 10:13pm
hds-website ✅ Ready (Inspect) Visit Preview Jan 23, 2025 10:13pm

@hashibot-hds hashibot-hds added the docs-website Content updates to the documentation website label Dec 27, 2024
@shleewhite shleewhite marked this pull request as ready for review December 27, 2024 00:58
@shleewhite shleewhite requested review from a team as code owners December 27, 2024 00:58
@shleewhite shleewhite force-pushed the hds-4231/advanced-table-docs branch from 652ffe1 to 9eeb1b9 Compare December 27, 2024 02:49
@shleewhite shleewhite force-pushed the hds-3965/advanced-table-clean branch from 313f25a to afe2716 Compare January 2, 2025 19:35
@shleewhite shleewhite force-pushed the hds-4231/advanced-table-docs branch from 9eeb1b9 to 881bf6a Compare January 6, 2025 14:56
Copy link
Contributor

@dchyun dchyun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs are looking great! 📝 👍 Just a few small fixes and questions I caught.

Copy link
Contributor

@andgen404 andgen404 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one suggestion, overall lgtm 🎉

@@ -481,7 +481,7 @@ To create a column that has right-aligned content, set `@align` to `right` on bo

Consuming a large amount of data in a tabular format can lead to an intense cognitive load for the user. As a general principle, care should be taken to simplify the information within a table as much as possible.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Suggestion] To reduce some of the content here.

Suggested change
Consuming a large amount of data in a tabular format can lead to an intense cognitive load for the user. As a general principle, care should be taken to simplify the information within a table as much as possible.
Simplify table content to reduce cognitive load.

Copy link
Member

@alex-ju alex-ju left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did a high-level review – seems good!

@shleewhite shleewhite merged commit 2282d8f into main Jan 23, 2025
10 checks passed
@shleewhite shleewhite deleted the hds-4231/advanced-table-docs branch January 23, 2025 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants