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

closes #11 #16

Merged
merged 12 commits into from
Apr 13, 2023
Merged

closes #11 #16

merged 12 commits into from
Apr 13, 2023

Conversation

alekseevaiana
Copy link
Member

What I did

  • updated Readme for developers (in root directory)
  • updated Readme inside ui-library package
  • cloned and created branch from keyp-docs, added page UI Library with usage information
  • removed section about UI from OAUTH

Next steps

Comments

  • I think that the usage of this package is not easy and I am willing to try to prebuild at least css file on the package side, so user don't have to merge tailwind.config.js files but use prebuilt css classes
  • I read about prebuilding js files for creating react components library, can try it too, so user don't have to eject and edit webpack on their side

Screenshot of how keyp-docs UI Library page will look like

top-page

bottom-page

@alekseevaiana alekseevaiana self-assigned this Apr 12, 2023
@alekseevaiana alekseevaiana linked an issue Apr 12, 2023 that may be closed by this pull request
2 tasks
@github-actions
Copy link

📦 PR Package Available

yarn add my-package@PR16 --registry https://npm.pkg.github.com
:octocat: Click to learn how to use Github packages

First create a personal access token with "read:packages" permission.

Next add the following lines to ~/.npmrc, replacing with your token. For more help see Installing a package from Github.

//npm.pkg.github.com/:_authToken=<TOKEN>

Copy link
Member

@pi0neerpat pi0neerpat left a comment

Choose a reason for hiding this comment

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

Looks good. Don't forget to add language descriptors on your code blocks for syntax highlighting:

const var =5;

We will work on improving the installation DX next, but this is great for now to just have something working.

@alekseevaiana alekseevaiana merged commit eb9e338 into dev Apr 13, 2023
@alekseevaiana alekseevaiana deleted the iana/documentation branch April 13, 2023 22:35
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.

Documentation
2 participants