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

fix: updates and adds implementation documentation for components #618

Merged
merged 4 commits into from
Aug 19, 2024

Conversation

HeleenSG
Copy link
Contributor

@HeleenSG HeleenSG commented Aug 12, 2024

Changes

  • Adds missing examples on how to import components into a project.
  • Updates old documentation to be consistent with the new examples.
  • Adds missing side-menu within doc pages

Closes: #611

Example:

Screenshot 2024-08-12 at 18 32 39

QA notes:

  • Please check for any copy/paste mistakes
  • Check if there are old examples or missing examples.

@HeleenSG HeleenSG self-assigned this Aug 12, 2024
@HeleenSG HeleenSG added the documentation Documentation improvements or additions label Aug 12, 2024
@HeleenSG HeleenSG marked this pull request as ready for review August 12, 2024 16:56
@HeleenSG HeleenSG requested a review from a team as a code owner August 12, 2024 16:56
@ppvg
Copy link
Member

ppvg commented Aug 14, 2024

De tekst "via npm" ontbreekt nog in de volgende component-pagina's:

Pagina's zonder "via npm"
❯ rg --files-without-match -i "via npm" **/components/**/+page.svelte | grep -v 'test/+page' | sort
docs/src/routes/(docs)/components/branding-colors/+page.svelte
docs/src/routes/(docs)/components/breadcrumb-bar-example/+page.svelte
docs/src/routes/(docs)/components/button/+page.svelte
docs/src/routes/(docs)/components/forms/+page.svelte
docs/src/routes/(docs)/components/icons/add-set/+page.svelte
docs/src/routes/(docs)/components/icons/+page.svelte
docs/src/routes/(docs)/components/main-test-content-wrapper-div/+page.svelte
docs/src/routes/(docs)/components/main-test-direct/+page.svelte
docs/src/routes/(docs)/components/main-test-div/+page.svelte
docs/src/routes/(docs)/components/notifications-page/+page.svelte
docs/src/routes/(docs)/components/notifications/+page.svelte
docs/src/routes/(docs)/components/+page.svelte
docs/src/routes/(docs)/components/sidemenu/+page.svelte
docs/src/routes/(docs)/components/table/+page.svelte
docs/src/routes/(docs)/components/tile-cover-image/+page.svelte
icore_open_docs/src/routes/(docs)/components/accordion/+page.svelte
icore_open_docs/src/routes/(docs)/components/branding-colors/+page.svelte
icore_open_docs/src/routes/(docs)/components/breadcrumb-bar-example/+page.svelte
icore_open_docs/src/routes/(docs)/components/button-call-to-action/+page.svelte
icore_open_docs/src/routes/(docs)/components/button-destructive/+page.svelte
icore_open_docs/src/routes/(docs)/components/button-dropdown/+page.svelte
icore_open_docs/src/routes/(docs)/components/button-ghost/+page.svelte
icore_open_docs/src/routes/(docs)/components/button-icon-only/+page.svelte
icore_open_docs/src/routes/(docs)/components/button-icon/+page.svelte
icore_open_docs/src/routes/(docs)/components/button/+page.svelte
icore_open_docs/src/routes/(docs)/components/collapsible/+page.svelte
icore_open_docs/src/routes/(docs)/components/filter/+page.svelte
icore_open_docs/src/routes/(docs)/components/finn-large/+page.svelte
icore_open_docs/src/routes/(docs)/components/finn-medium/+page.svelte
icore_open_docs/src/routes/(docs)/components/finn-small/+page.svelte
icore_open_docs/src/routes/(docs)/components/focus-only/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-accent-color/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-base/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-columns/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-combined-fields/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-fieldset-invisible/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-help/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-horizontal-view/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-inline/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-input-color-filled/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-input-color/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-input-date/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-input-email/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-input-file/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-input/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-input-password/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-input-range/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-input-textarea/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-required/+page.svelte
icore_open_docs/src/routes/(docs)/components/form-select/+page.svelte
icore_open_docs/src/routes/(docs)/components/forms/+page.svelte
icore_open_docs/src/routes/(docs)/components/hidden/+page.svelte
icore_open_docs/src/routes/(docs)/components/horizontal-scroll/+page.svelte
icore_open_docs/src/routes/(docs)/components/horizontal-view/+page.svelte
icore_open_docs/src/routes/(docs)/components/icons/add-set/+page.svelte
icore_open_docs/src/routes/(docs)/components/icons/+page.svelte
icore_open_docs/src/routes/(docs)/components/image-cover/+page.svelte
icore_open_docs/src/routes/(docs)/components/image-icon/+page.svelte
icore_open_docs/src/routes/(docs)/components/image-round/+page.svelte
icore_open_docs/src/routes/(docs)/components/image-square/+page.svelte
icore_open_docs/src/routes/(docs)/components/layout-authentication/+page.svelte
icore_open_docs/src/routes/(docs)/components/layout-centered/+page.svelte
icore_open_docs/src/routes/(docs)/components/layout-column-2/+page.svelte
icore_open_docs/src/routes/(docs)/components/layout-column-3/+page.svelte
icore_open_docs/src/routes/(docs)/components/layout-column-4/+page.svelte
icore_open_docs/src/routes/(docs)/components/login-meta/+page.svelte
icore_open_docs/src/routes/(docs)/components/logo/+page.svelte
icore_open_docs/src/routes/(docs)/components/main-test-content-wrapper-div/+page.svelte
icore_open_docs/src/routes/(docs)/components/main-test-direct/+page.svelte
icore_open_docs/src/routes/(docs)/components/main-test-div/+page.svelte
icore_open_docs/src/routes/(docs)/components/max-line-length/+page.svelte
icore_open_docs/src/routes/(docs)/components/message-counter/+page.svelte
icore_open_docs/src/routes/(docs)/components/nota-bene/+page.svelte
icore_open_docs/src/routes/(docs)/components/notification-confirmation/+page.svelte
icore_open_docs/src/routes/(docs)/components/notification-error/+page.svelte
icore_open_docs/src/routes/(docs)/components/notification-explanation/+page.svelte
icore_open_docs/src/routes/(docs)/components/notifications-page/+page.svelte
icore_open_docs/src/routes/(docs)/components/notifications/+page.svelte
icore_open_docs/src/routes/(docs)/components/notifications-paragraph/+page.svelte
icore_open_docs/src/routes/(docs)/components/notifications-table/+page.svelte
icore_open_docs/src/routes/(docs)/components/notification-system-message/+page.svelte
icore_open_docs/src/routes/(docs)/components/notification-warning/+page.svelte
icore_open_docs/src/routes/(docs)/components/nowrap/+page.svelte
icore_open_docs/src/routes/(docs)/components/+page.svelte
icore_open_docs/src/routes/(docs)/components/sidemenu/+page.svelte
icore_open_docs/src/routes/(docs)/components/spot-medium/+page.svelte
icore_open_docs/src/routes/(docs)/components/spot-mini/+page.svelte
icore_open_docs/src/routes/(docs)/components/spot-small/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-action-buttons/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-base/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-caption/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-checkbox/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-condensed/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-expando-row/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-multiple-columns/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-multiple-rows/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-notifications/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-numerical-data/+page.svelte
icore_open_docs/src/routes/(docs)/components/table/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-scope/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-sortable/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-sticky-header/+page.svelte
icore_open_docs/src/routes/(docs)/components/table-summary/+page.svelte
icore_open_docs/src/routes/(docs)/components/tile-cover-image/+page.svelte
icore_open_docs/src/routes/(docs)/components/tile-groups/+page.svelte
icore_open_docs/src/routes/(docs)/components/tiles/+page.svelte

@ppvg ppvg merged commit 7c4758e into main Aug 19, 2024
9 checks passed
@ppvg ppvg deleted the fix/file-reference branch August 19, 2024 09:43
@HeleenSG
Copy link
Contributor Author

Ticket: #626

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation improvements or additions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add @use import examples to all components' documentation
3 participants