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.

Sign up for GitHub

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

Jump to bottom

[EUI+] Reorganize+improve markdown, tables, and data grid docs #8183

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

[EUI+] Reorganize+improve markdown, tables, and data grid docs #8183

wants to merge 3 commits into from

Conversation

cee-chen
Copy link
Member

Summary

TODO: data grid :|

QA

Remove or strikethrough items that do not apply to your PR.

General checklist

  • Browser QA
    • Checked in both light and dark modes
    • Checked in mobile
    • Checked in Chrome, Safari, Edge, and Firefox
    • Checked for accessibility including keyboard-only and screenreader modes
  • Docs site QA
  • Code quality checklist
  • Release checklist
    • A changelog entry exists and is marked appropriately.
    • If applicable, added the breaking change issue label (and filled out the breaking change checklist)
  • Designer checklist
    • If applicable, file an issue to update EUI's Figma library with any corresponding UI changes. (This is an internal repo, if you are external to Elastic, ask a maintainer to submit this request)

@cee-chen cee-chen added documentation Issues or PRs that only affect documentation - will not need changelog entries skip-changelog labels Nov 23, 2024
@cee-chen
Reorganize/clean up EuiMarkdown* docs
ced2a85 
+ several opinionated copy updates - move unregistering plugins to the plugins page, where it feels like it belongs significantly more
@cee-chen
Reorganize and clean up tables documentation
a66aac5 
- create subpages, rewrite overview

- move the table building blocks example to its own page (much better props DX)

- rewrite a bunch of things that felt really hard to understand DX-wise

- rewrite EuiBasicTable docs with in-memory table in mind (it felt
- remove a bunch of manual pagination/sorting examples from docs - unnecessary extra complexity

- improve smaller screen display by removing columns that didn't add much to DX use cases
@kibanamachine
Copy link

Preview staging links for this PR:

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries skip-changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cee-chen @kibanamachine @elasticmachine