Skip to content

Commit

Permalink
docs: readded contributing section, changed some references of kata-kit
Browse files Browse the repository at this point in the history
  • Loading branch information
resir014 committed Oct 29, 2018
1 parent d824d70 commit 4fb0a10
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 12 deletions.
4 changes: 4 additions & 0 deletions .storybook/__stories__/docs.story.tsx
Expand Up @@ -8,6 +8,7 @@ import IntroHeader from 'components/IntroHeader';

import Introduction from '@docs/introduction.md';
import GettingStarted from '@docs/getting-started.md';
import Contributing from '@docs/contributing.md';
import UsingAssets from '@docs/using-assets.md';
import Fonts from '@docs/fonts.md';
import Theming from '@docs/theming.md';
Expand Down Expand Up @@ -49,6 +50,9 @@ story.add('Introduction', () => (
story.add('Getting Started', () => (
<Markdown source={GettingStarted} renderers={markdownRenderers} />
));
story.add('Contributing', () => (
<Markdown source={Contributing} renderers={markdownRenderers} />
));
story.add('Using Assets', () => (
<Markdown source={UsingAssets} renderers={markdownRenderers} />
));
Expand Down
11 changes: 1 addition & 10 deletions CONTRIBUTING.md
@@ -1,6 +1,6 @@
# Contributing Guidelines

kata-kit is open source, so every component in kata-kit is developed by your help. You too can help contribute to this project! This page describes how to setup the project on your computer for local development.
Wicara is open source, so every component in Wicara is developed by your help. You too can help contribute to this project! This page describes how to setup the project on your computer for local development.

This project is bound by a [Code of Conduct](CODE_OF_CONDUCT.md).

Expand Down Expand Up @@ -82,12 +82,3 @@ info Storybook started on => http://localhost:9001/
```

The storybook server is available at `http://localhost:9001`. Note that any new component needs to have at least one story as a demo.

### Demo Page

The kata-kit website (located on the `website/` folder) also serves as a development environment for our components. Run the following command to start it locally:

```sh-session
$ cd website
$ yarn dev
```
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -20,6 +20,12 @@

---

## Contributing

Wicara is developed by the help of developers like you! Please read our [Contributing Guidelines](CONTRIBUTING.md) to get started on developing Wicara.

This project is bound by a [Code of Conduct](CODE_OF_CONDUCT.md).

## Usage

### Prerequisites
Expand Down
5 changes: 5 additions & 0 deletions docs/contributing.md
@@ -0,0 +1,5 @@
# Contributing

Wicara is developed by the help of developers like you! Please read our [Contributing Guidelines](https://github.com/kata-ai/kata-kit/blob/master/CONTRIBUTING.md) to get started on developing Wicara.

This project is bound by a [Code of Conduct](https://github.com/kata-ai/kata-kit/blob/master/CODE_OF_CONDUCT.md).
4 changes: 2 additions & 2 deletions docs/theming.md
@@ -1,10 +1,10 @@
# Theming

`@kata-kit/theme` contains source code for the kata-kit theming framework.
`@kata-kit/theme` contains source code for the Wicara theming framework.

We use `styled-components` for styling our components, which combines the power of CSS-in-JS, as well as the familiarity of regular SCSS, through the power of tagged template literals. This package provides top-level and inner-level style resets, as well as abstractions on top of styled-components, which allows for simpler component theming.

## How Theming Works in `kata-kit`
## How Theming Works in Wicara

`styled-components` has its own theming support with the `ThemeProvider` component, however it's quite convoluted when you try to solve global/local theming hierarches.

Expand Down

0 comments on commit 4fb0a10

Please sign in to comment.