primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-11-22 19:01:02 +03:00
Code Issues Projects Releases Wiki Activity

docs: nix "why Metalsmith?", document URL tests

Browse Source
This commit is contained in:
Shawn Allen 2019-02-14 17:03:12 -08:00 committed by GitHub
parent 56e0f3b7e3
commit 45b379aebf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
DEVELOP.md
View File

@ -78,10 +78,14 @@ We use [Metalsmith] to sync the source docs to the `pages` directory and transfo
All of the logic for syncing the source docs (and transforming them in transit) is controlled in [`lib/sync.js`](./lib/sync.js), and each "step" in the transformation (as well as the watching) is implemented as a Metalsmith plugin.
**Why [Metalsmith]?** We're glad you asked! `@shawnbot` likes the simplicity of Metalsmith's core and how easy it is to write powerful plugins. If you have ideas for improving this process, [we're all ears](/primer/css/issues/new)!
### URL tests
We have a script that catches inadvertent URL changes caused by renaming or deleting Markdown docs:
### TODO
* Document URL tests
```sh
npm run test-urls
```
This script includes some exceptions for URLs that have been intentionally moved or removed in the process of moving away from the [GitHub Style Guide](https://styleguide.github.com/primer/), and which you will need to modify if you rename or remove either Markdown docs or their `path` frontmatter. See [#641](https://github.com/primer/css/pull/641) for more information.
## Storybook
To borrow a [metaphor from Brad Frost](http://bradfrost.com/blog/post/the-workshop-and-the-storefront/), the [docs site](#docs-site) is Primer CSS's storefront, and [Storybook] is its workshop.