Skip to content

Commit eeea7bd

Browse files
committed
docs(readme): update README for marketing websites
1 parent c5db2d4 commit eeea7bd

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

README.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
# Code.org Frontend
1+
# Code.org Marketing Websites
22

3-
This directory contains packages and applications that power Code.org sites.
4-
5-
**Note**: Most of Code.org's Studio product (student experience, curriculum, teacher tools, etc.) is built in the
6-
top-level `apps` package and is not currently located in this directory.
3+
This directory contains packages and applications that power Code.org marketing websites. For Code.org's learning platform, see [this repository](https://github.com/code-dot-org/code-dot-org).
74

85
## What's inside?
96

@@ -14,22 +11,22 @@ This directory uses [Turborepo](https://turbo.build/) to manage the monorepo and
1411

1512
### Apps
1613

17-
Open source Code.org applications:
14+
Open source Code.org marketing applications:
1815

1916
- [@code-dot-org/marketing](apps/marketing): Code.org's marketing site (uses Contentful).
20-
- [@code-dot-org/design-system-storybook](apps/design-system-storybook): A [Storybook](https://storybook.js.org/)
21-
instance for the Code.org design system (`@code-dot-org/component-library`). Publicly available at
22-
[https://code-dot-org.github.io/code-dot-org/component-library-storybook](https://code-dot-org.github.io/code-dot-org/component-library-storybook).
17+
- [@code-dot-org/design-system-storybook](apps/marketing-storybook): A [Storybook](https://storybook.js.org/)
18+
instance for the Code.org design system (`@code-dot-org/marketing-component-library`). Publicly available at
19+
[https://code-dot-org.github.io/code-dot-org/marketing-component-library-storybook](https://code-dot-org.github.io/code-dot-org/marketing-component-library-storybook).
2320

2421
### Packages
2522

2623
Publicly available packages:
2724

28-
- [@code-dot-org/component-library](packages/component-library): The Code.org Design System React component library.
29-
- [@code-dot-org/component-library-styles](packages/component-library-styles): Common Styles
30-
(`variables`, `colors`, `mixins`, `typography styles`, etc) of Code.org Design System
31-
([@code-dot-org/component-library](packages/component-library)). Based on [Figma](https://www.figma.com/design/NIVcvUgU3WmXpAmp9U2vVy/DSCO-Variables?node-id=2925-33951&m=dev).
32-
Used by [@code-dot-org/component-library](packages/component-library), should also be used as
25+
- [@code-dot-org/marketing-component-library](packages/marketing-component-library): The Code.org Marketing Design System React component library.
26+
- [@code-dot-org/marketing-component-library-styles](packages/marketing-component-library-styles): Common Styles
27+
(`variables`, `colors`, `mixins`, `typography styles`, etc) of Code.org Marketing Design System
28+
([@code-dot-org/marketing-component-library](packages/marketing-component-library)). Based on [Figma](https://www.figma.com/design/NIVcvUgU3WmXpAmp9U2vVy/DSCO-Variables?node-id=2925-33951&m=dev).
29+
Used by [@code-dot-org/marketing-component-library](packages/marketing-component-library), should also be used as
3330
a standalone package for styling components with Code.org's Design System styles.
3431
- [@code-dot-org/lint-config](packages/lint-config): Shared linters configuration for Code.org projects
3532
(includes `eslint`, `lint-staged,` `prettier`, `stylelint`, `typescript` configs).
@@ -40,7 +37,7 @@ Publicly available packages:
4037
## Getting Started
4138

4239
_(!!!)_ If you're unable to find some information in this README.md, please refer to the documentation of package/app
43-
that you're working on. (e.g. go to [packages/component-library/README.md](packages/component-library/README.md),
40+
that you're working on. (e.g. go to [packages/marketing-component-library/README.md](packages/marketing-component-library/README.md),
4441
[apps/marketing/README.md](apps/marketing/README.md), etc)
4542

4643
### Prerequisites
@@ -81,7 +78,7 @@ More information on this command [here](https://yarnpkg.com/cli/workspace).
8178
For example, to only run the design system storybook:
8279

8380
```bash
84-
yarn workspace @code-dot-org/design-system-storybook dev
81+
yarn workspace @code-dot-org/marketing-storybook dev
8582
```
8683

8784
### Formatting, Linting. (Prettier, ESLint, Stylelint)
@@ -95,11 +92,11 @@ yarn lint:fix
9592
You can also run this command for some specific package or app using yarn workspace:
9693

9794
```bash
98-
yarn lint:fix --filter @code-dot-org/component-library
95+
yarn lint:fix --filter @code-dot-org/marketing-component-library
9996

10097
OR
10198

102-
yarn workspace @code-dot-org/component-library lint:fix
99+
yarn workspace @code-dot-org/marketing-component-library lint:fix
103100
```
104101

105102
### Pre-release Testing

0 commit comments

Comments
 (0)