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

Button docs #165

Merged
merged 24 commits into from
Mar 5, 2021
Merged

Conversation

indirectlylit
Copy link
Contributor

@indirectlylit indirectlylit commented Feb 17, 2021

Component documentation

Adds documentation for library components:

  • KButton
  • KRouterLink
  • KExternalLink
  • KButtonGroup
  • KIconButton

2021-02-23 09 57 09

Filter keywords

Adds a new 'keywords' property to the table of contents to allow filtering by related terms. For example:

      new Page({
        path: '/KButton',
        title: 'KButton',
        isCode: true,
        keywords: ['button', 'link'],
      }),

2021-02-23 09 49 24

Cross-links to components

Adds a new DocsLibraryLink component to allow easy cross-linking. For example:

<DocsLibraryLink page="KExternalLink" /> is used to create standard <code>&lt;a&gt;</code> tags with an <code>href</code> attribute.

2021-02-23 09 52 18

@indirectlylit indirectlylit force-pushed the button-docs branch 6 times, most recently from 0f2e263 to 473f865 Compare February 23, 2021 17:55
@indirectlylit indirectlylit changed the title Work-in-progress on button docs Button docs Feb 23, 2021
@sairina
Copy link
Contributor

sairina commented Feb 25, 2021

This is great! Two follow-ups, I believe:

  1. We may also want to update the README (for example to include <DocsLibraryLink>?)
  2. While we're in the README, I think there also is a small typo in the README here where it says
cd design-system
yarn install 

and I think it should be cd kolibri-design-system

Copy link
Contributor

@sairina sairina left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@nucleogenesis nucleogenesis left a comment

Choose a reason for hiding this comment

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

This PR is awesome.

One bug I've noted (possibly unrelated to this work) is that the filtering in the sidebar isn't working 100% correctly.

I can make a new issue if it's not related to this work.

image

@indirectlylit
Copy link
Contributor Author

indirectlylit commented Feb 27, 2021

thanks for the feedback both. Ready for re-review.

@nucleogenesis added a basic unit test for that filter, but I am not actually sure that github actions is actually running the test suite. Need to investigate

Copy link
Contributor

@sairina sairina left a comment

Choose a reason for hiding this comment

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

Good eye - @nucleogenesis ! Manually tested the issue that he brought up, and the filtering with "button" seems to work now. LGTM!

docs/pages/buttons.vue Outdated Show resolved Hide resolved
Co-authored-by: Jessica Aceret <[email protected]>
@indirectlylit indirectlylit merged commit 99547a2 into learningequality:v0.2.x Mar 5, 2021
@indirectlylit indirectlylit deleted the button-docs branch March 5, 2021 23:31
@indirectlylit indirectlylit mentioned this pull request Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants